Skip to content

Latest commit

 

History

History
97 lines (67 loc) · 2.78 KB

CONTRIBUTING.md

File metadata and controls

97 lines (67 loc) · 2.78 KB
Raw

Contributor's Guide

https://github.com/BolajiAyodeji/netty-finder.git
  • Install dependencies
npm install
  • To build
npm run build
  • Create a branch specific to the issue you are working on.
git checkout -b update-readme-file

For clarity to yourself and others on the issue you're working on, name your branch something like update-xxx or fix-xxx where xxx is a short description of the changes you're making. For example update-readme or fix-typo-on-contribution-md.

  • Open up the project in your favourite text editor, select the file you want to contribute to and make your changes.

  • After making your changes in the new git branch then add your modified files to git, How to add, commit, push and go.

git add path/to/filename.ext

You can also add all unstaged files using:

git add .

Note, using a git add . will automatically add all files. You can do a git status to see your changes, but do it before git add.

  • Commit your changes using a descriptive commit message.
git commit -m "Brief Description of Commit"
  • Push your commits to your Github Fork:
git push -u origin branch-name

  • Submit a pull request.

    Within GitHub, visit this main repository and you should see a banner suggesting to make a pull request. While you're writing up the pull request, you can add Closes #XXX in the message body where #XXX is the issue you're fixing. So an example would be Closes #42 would close issue #42.

Submitting a Pull Request

What is a pull request?

If you decide to fix an issue, it's advisable to check the comment thread in case there's somebody already working on a fix. If no one is working on it at the moment, kindly leave a comment stating that you intend to work on it so other people don't accidentally duplicate your effort.

In a situation whereby somebody decides to fix an issue but doesn't follow up for a particular period of time, say 2-3 weeks, it's acceptable to still pick up the issue but make sure to leave a comment.

Helpful Resources