Skip to content

Latest commit

 

History

History
96 lines (60 loc) · 3.14 KB

CONTRIBUTING.md

File metadata and controls

96 lines (60 loc) · 3.14 KB
Raw

Contributing Guidelines

ℹ️ Please follow the code of conduct in all the interactions with Searchor and your fork repository.

The following is a set of guidelines for contributing to Weather-app-api, which is hosted on Github. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

How Can I Contribute?

In order to discuss changes, you are welcome to open an issue about what you would like to contribute. Enhancements are always encouraged and appreciated.

⭐ HOW TO MAKE A PULL REQUEST:

1. Start by making a Fork of the Weather-app-api repository. Click on the Fork symbol at the top right corner.

2. Clone your new fork of the repository in the terminal/CLI on your computer with the following command:

git clone https://github.com/<your-github-username>/weather-app-api

3. Navigate to the newly created weather-app-api project directory:

cd weather-app-api

4. Set upstream command:

git remote add upstream https://github.com/codemaniac-sahil/weather-app-api.git

5. Create a new branch:

git checkout -b YourBranchName

6. Sync your fork or your local repository with the origin repository:

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

Alternatively, Git CLI way to Sync forked repository with origin repository:

git fetch upstream
git merge upstream/main

Github Docs for Syncing

7. Make your changes to the source code.

8. Stage your changes:

⚠️ Make sure not to commit package.json or package-lock.json file

⚠️ Make sure not to run the commands git add . or git add *

Instead, stage your changes for each file/folder

By using public path it means it will add all files and folders under that folder, it is better to be specific

git add public

or

git add "<files_you_have_changed>"

9. Commit your changes:

git commit -m "<your_commit_message>"

10. Push your local commits to the remote repository:

git push origin YourBranchName

11. Create a Pull Request!

12. Congratulations! You've made your first contribution to Weather-app-api! 🙌🏼

🏆 After this, the maintainers will review the PR and will merge it if it helps move the project forward. Otherwise, it will be given constructive feedback and suggestions for the changes needed to add the PR to the codebase.