Skip to content

Latest commit

 

History

History
108 lines (68 loc) · 4.34 KB

contributing.md

File metadata and controls

108 lines (68 loc) · 4.34 KB

Contributing to Blaze

PRs Welcome GitHub Issues GitHub PRs

We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Submitting a fix
  • Proposing new features
  • Raising an issue
  • Enhancing existing features

Getting Started

Please follow these simple steps to start working:

1. If you want to work on issue then comment. If you get assigned, Fork this repository.

Screenshot 2022-12-05 at 10 06 51 AM

2. Clone your forked copy of the project.

git clone https://github.com/<your-github-username>/Blaze.git

Screenshot 2022-12-05 at 10 12 07 AM

3. Navigate to your project directory and open it in your code editor. 📁 .

cd Blaze

Screenshot 2022-12-05 at 10 13 36 AM

4. Add a reference(remote) to the original repository.

git remote add upstream https://github.com/boradesanket13/Blaze.git

Screenshot 2022-12-05 at 10 15 37 AM

5. Check the remotes for this repository.

git remote -v

Screenshot 2022-12-05 at 10 16 20 AM

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

Screenshot 2022-12-05 at 10 17 05 AM

7. Create a new branch.

git checkout -b <your_branch_name>

Screenshot 2022-12-05 at 10 18 16 AM

8. Perform your desired changes to the code base.

9. Track your changes:heavy_check_mark: .

git add . 

10. Commit your changes .

git commit -m "Relevant message"

App Screenshot

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

git push -u origin <your_branch_name>

Screenshot 2022-12-05 at 10 19 02 AM

12. Open a Pull Request with a name of the issue and describe about your changes with reasons. To create a pull request, click on compare and pull requests. Please ensure you compare your feature branch to the desired branch of the repository you are supposed to make a PR to.

13. Add appropriate title and description to your pull request explaining your changes and efforts done.

14. Click on Create Pull Request.

App Screenshot

15 Voila!
16 Woohoo! You have made a PR to the boradesanket13/Blaze 💥 . Wait for your submission to be accepted and your PR to be merged.

Thank you for your interest in contributing to our Repo!🏼

Kudos to you🎈 Whoohooo!