Skip to content

Latest commit

 

History

History
112 lines (76 loc) · 3.33 KB

CONTRIBUTING.md

File metadata and controls

112 lines (76 loc) · 3.33 KB

Contributing to firstspot

First of all thanks for taking time to contribute!

The following is a set of guidelines for contributing to firstspot.

Table Of Contents

  1. Code of Conduct
  2. Ways to Contribute
  3. How to Contribute
  4. Submitting Pull Requests

Code of Conduct

This project and everyone participating in it is governed by the firstspot Code of Conduct.

Ways to Contribute

Code Contributions

  • Fix Bugs: Identify and fix bugs by submitting pull requests with code changes.
  • Add Features: Contribute new features or enhancements to improve the project.
  • Optimize Code: Optimize existing code for better performance or readability.

Documentation

  • Update Documentation: Improve and update project documentation, including README files, guides, and inline code comments.

Issue Reporting

  • Bug Reporting: Report bugs by creating clear and reproducible bug reports.
  • Feature Requests: Share ideas and request new features by opening well-documented issues.

How to Contribute

1. Explore existing Issues or create a new issue.

Note: Only start work on the issue after getting assigned by the repository maintainer.

2. Fork the Repository.

Click the "Fork" button on the GitHub repository to create your own copy of the project.

fork

3. Clone Your Fork

git clone https://github.com/<yourusername>/firstspot.git

4. Navigate to the newly created firstspot project directory:

cd firstspot

5. Set upstream command

Set the upstream to synchronize your forked repository with the original repository.

git remote add upstream https://github.com/jaysomani/firstspot

6. Create a new branch

git checkout -b YourBranchName

7. Sync your fork or your local repository with the origin repository

Method 1:

using the Command Line Interface.

git fetch upstream

git merge upstream/main

Method 2:

Using the github Graphical User Interface.

  • In your forked repository, click on "Fetch upstream"
  • Click "Fetch and merge"

8. Make your changes to the source code.

9. Stage your changes and commit

⚠️ Make sure not to run the commands git add . or git add *. Instead, stage your changes for each file/folder

git add <file/folder_you_made_changes_to>
git commit -m  "<your_commit_message>"

10. Push your local commits to the remote repository

git push origin yourBranchName

11. In your forked repository create a Pull Request(PR)

See the Pull Requests guidelines here.

Note: After making PR wait for the PR to be reviewed and make changes if required.

12. Congratulations!🎉 You've made your first contribution to firstspot! 🙌🏼

Submitting Pull Requests

When submitting a pull request, please ensure the following:

  • You have added necessary tests for your changes.
  • The pull request description clearly explains the changes made and the reasoning behind them.
  • Screenshot of the changes.