Skip to content

Latest commit

 

History

History
117 lines (72 loc) · 4.88 KB

CONTRIBUTING.md

File metadata and controls

117 lines (72 loc) · 4.88 KB
Raw

Contributors

💥 How to Contribute

PRs Welcome Open Source Love

  • Take a look at the existing Issues or create a new issue!
  • Fork the Repo. Then, create a branch for any issue that you are working on. Finally, commit your work.
  • Create a Pull Request (PR), which will be promptly reviewed and given suggestions for improvements by the community.
  • Add screenshots or screen captures to your Pull Request to help us understand the effects of the changes proposed in your PR.
  • Please open an issue first before contributing a Pull Request, to prevent you from building features or spending time on things, that aren't intended to be merged to the main branch.

💥 Issues

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.

Before Starting:

  • Search Existing Issues: Before creating a new issue, take a moment to search the existing issues to ensure that the topic hasn't already been discussed or addressed.

  • Check Documentation: Make sure you have read any relevant documentation or guidelines related to the project. This will help you understand the context and requirements of the issue you're reporting or suggesting.

⭐ HOW TO MAKE A PULL REQUEST:

1. Start by making a Fork of the good-first-issue-finder 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>/good-first-issue-finder

3. Navigate to the newly created good-first-issue-finder project directory:

cd good-first-issue-finder

4. Set upstream command:

git remote add upstream https://github.com/EddieHubCommunity/good-first-issue-finder.git

5. Create a new branch:

git checkout -b YourBranchName

6. Add secret github token in a .env file:

  • Add a .env file in the root directory of the folder

  • Paste the code below inside the .env file with your secret token

GH_TOKEN=<Your-Super-Secret-Github-Token>

Note: A detailed explanation on how to create a GitHub Token can be found here

7. 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

8. Make your changes to the source code.

9. Stage your changes and commit:

⚠️ 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

git add <filename>
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 good-first-issue-finder! 🙌🏼

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

All the best! 🥇

built with love

Join the conversation in our Discord community