Skip to content

Latest commit

 

History

History
96 lines (67 loc) · 3.74 KB

CONTRIBUTING.md

File metadata and controls

96 lines (67 loc) · 3.74 KB
Raw

Contributing

Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Issues and PRs

If you have suggestions for how this project could be improved, or want to report a bug, open an issue! We'd love all and any contributions. If you have questions, too, we'd love to hear them.

We'd also love PRs. If you're thinking of a large PR, we advise opening up an issue first to talk about it, though! Look at the links below if you're not sure how to open a PR.

How to Contribute

  • Take a look at the Existing Issues or create your own!
  • Fork the Repo and create a Branch for any Issue that you are working upon.
  • Create a Pull Request which will be promptly reviewed and suggestions would be added to improve it.
  • Add Screenshots to help us know what this is all about.

How to make a Pull Request

1. Fork the repository by clicking on the symbol at the top right corner.

2. Clone the forked repository.

   git clone https://github.com/SauravMukherjee44/CodeIN-Community-Website.git

3. Navigate to the project directory.

   cd CodeIN-Community-Website

4. Create a new branch:

   git checkout -b YourBranchName

5. Make changes in source code.

6. Stage your changes and commit

   git add .
   git commit -m "<your_commit_message>"

7. Push your local commits to the remote repo.

   git push origin YourBranchName

8. Create a PR

Note If anyone contributes to this repository, then the changes will not be reflected in your local repository. For that:

9. Setup a reference(remote) to the original repository to get all the changes from the remote.

   git remote add upstream  https://github.com/SauravMukherjee44/CodeIN-Community-Website.git

10. Check the remotes for this repository.

   git remote -v

11. Fetching from the remote repository will bring in its branches and their respective commits.

   git fetch upstream

12. Make sure that you're on your master branch.

   git checkout master

13. Now that we have fetched the upstream repository, we want to merge its changes into our local branch. This will bring that branch into sync with the upstream, without losing our local changes.

   git merge upstream/master

Here are a few things you can do that will increase the likelihood of your pull request being accepted:

  • Follow the style guide. Any linting errors should be shown when running npm test.
  • Write and update tests.
  • Keep your changes as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
  • Write a good commit message.

Work in Progress pull requests are also welcome to get feedback early on, or if there is something blocking you from working further.

Resources