Skip to content

Latest commit

 

History

History
108 lines (65 loc) · 3.21 KB

CONTRIBUTING.md

File metadata and controls

108 lines (65 loc) · 3.21 KB
Raw

Guidelines for Contribution

Contributing

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

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 make a Pull Request?

1. Fork this repository.

2. Clone your forked copy of the project.

git clone --depth 1 https://github.com/<your_user_name>/Rudra.git

3. Navigate to the project directory 📁 .

cd Rudra

4. Add a reference to the original repository.

git remote add upstream https://github.com/Harshal0902/Rudra.git

5. Check the remotes for this repository.

git remote -v

6. Always take a pull from the upstream repository to your master branch to keep it at par with the main project(updated repository).

git pull upstream main

7. Create a new branch.

git checkout -b <your_branch_name>

8. Perfom your desired changes to the code base.

9. Track your changes:heavy_check_mark: .

git add .

10. Check for the changes .

git status

11. Commit your changes .

git commit -m "Relevant message"

12. Push the committed changes in your feature branch to your remote repo.

git push -u origin <your_branch_name>

13. To create a pull request, click on compare and pull requests. Please ensure you compare your feature branch to the desired branch of the repo you are suppose to make a PR to.

14. Then add an appropriate title and description to your pull request that explains your changes and efforts done.

15. Click on Create Pull Request on main branch.

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

  • Follow the guidelines which is using standard. Any linting errors should be corrected before submittig a PR.
  • 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 blocked you.

Resources