Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve code formatting #36

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ newPRWelcomeComment: >
Bluelearn is India’s smartest student community!
Join niche clubs, interact with experts, explore, network with high-profile and ambitious individuals, get internships all for free! What are you waiting for?
[Join discord server here](https://discord.gg/8yTvfJq2)

firstPRMergeComment: >
Congrats on merging your first pull request! 🎉🎉🎉
newIssueWelcomeComment: >
Thanks for opening this issue, a maintainer will get back to you shortly!
Thanks for opening this issue, a maintainer will get back to you shortly!
3 changes: 3 additions & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Ignore artifacts:
dist
node_modules
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,23 @@

# How to contribute?

Step 1 : Fork, CLone and Remote
Step 1 : Fork, CLone and Remote

Step 2 : Install ```pnpm```, if you have Node installed already. If you don't, install Node first and then install ```pnpm```
Step 2 : Install `pnpm`, if you have Node installed already. If you don't, install Node first and then install `pnpm`

Install using npm :
```npm install -g pnpm```
`npm install -g pnpm`

Install using Homebrew :
``` brew install pnpm```
` brew install pnpm`

Step 3 : Open terminal, go to the local folder and execute
```pnpm install```
Step 3 : Open terminal, go to the local folder and execute
`pnpm install`

Step 4 : Run the project using ```pnpm run dev```. Open local host to check if it is running successfully.
Step 4 : Run the project using `pnpm run dev`. Open local host to check if it is running successfully.

Step 5 : Create a new branch using the commmand
``` git branch -b <branchname> ``` then make the required changes, commit the changes and push them.
Step 5 : Create a new branch using the commmand
`git branch -b <branchname>` then make the required changes, commit the changes and push them.

Step 6 : Create a Pull Request here.

Expand Down
14 changes: 10 additions & 4 deletions contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,14 @@ First off, thanks for taking the time to contribute! ❤️
All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉

> And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:
>
> - Star the project
> - Tweet about it
> - Refer this project in your project's readme
> - Mention the project at local meetups and tell your friends/colleagues

<!-- omit in toc -->

## Table of Contents

- [Code of Conduct](#code-of-conduct)
Expand All @@ -24,15 +26,13 @@ All types of contributions are encouraged and valued. See the [Table of Contents
- [Commit Messages](#commit-messages)
- [Join The Project Team](#join-the-project-team)


## Code of Conduct

This project and everyone participating in it is governed by the
[Let's Blue The Hacktoberfest Code of Conduct](https://github.com/bluelearn-open-source/Lets-Blue-The-Hacktoberfestblob/master/CODE_OF_CONDUCT.md).
By participating, you are expected to uphold this code. Please report unacceptable behavior
to <>.


## I Have a Question

> If you want to ask a question, we assume that you have read the available [Documentation](https://lets-blue-the-hacktoberfest.vercel.app).
Expand Down Expand Up @@ -65,11 +65,13 @@ Depending on how large the project is, you may want to outsource the questioning
## I Want To Contribute

> ### Legal Notice <!-- omit in toc -->
>
> When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.

### Reporting Bugs

<!-- omit in toc -->

#### Before Submitting a Bug Report

A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.
Expand All @@ -86,16 +88,18 @@ A good bug report shouldn't leave others needing to chase you up for more inform
- Can you reliably reproduce the issue? And can you also reproduce it with older versions?

<!-- omit in toc -->

#### How Do I Submit a Good Bug Report?

> You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to <>.

<!-- You may add a PGP key to allow the messages to be sent encrypted as well. -->

We use GitHub issues to track bugs and errors. If you run into an issue with the project:

- Open an [Issue](https://github.com/bluelearn-open-source/Lets-Blue-The-Hacktoberfest/issues/new). (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
- Explain the behavior you would expect and the actual behavior.
- Please provide as much context as possible and describe the *reproduction steps* that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.
- Please provide as much context as possible and describe the _reproduction steps_ that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.
- Provide the information you collected in the previous section.

Once it's filed:
Expand All @@ -106,12 +110,12 @@ Once it's filed:

<!-- You might want to create an issue template for bugs and errors that can be used as a guide and that defines the structure of the information to be included. If you do so, reference it here in the description. -->


### Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for Let's Blue The Hacktoberfest, **including completely new features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.

<!-- omit in toc -->

#### Before Submitting an Enhancement

- Make sure that you are using the latest version.
Expand All @@ -120,6 +124,7 @@ This section guides you through submitting an enhancement suggestion for Let's B
- Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library.

<!-- omit in toc -->

#### How Do I Submit a Good Enhancement Suggestion?

Enhancement suggestions are tracked as [GitHub issues](https://github.com/bluelearn-open-source/Lets-Blue-The-Hacktoberfest/issues).
Expand All @@ -133,6 +138,7 @@ Enhancement suggestions are tracked as [GitHub issues](https://github.com/bluele
<!-- You might want to create an issue template for enhancement suggestions that can be used as a guide and that defines the structure of the information to be included. If you do so, reference it here in the description. -->

### Your First Code Contribution

<!-- TODO
include Setup of env, IDE and typical getting started instructions?

Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
"@types/react": "^18.0.17",
"@types/react-dom": "^18.0.6",
"@vitejs/plugin-react": "^2.0.1",
"prettier": "2.7.1",
"vite": "^3.0.7"
}
}
Loading