Skip to content

Latest commit

 

History

History
75 lines (58 loc) · 2.9 KB

CONTRIBUTING.md

File metadata and controls

75 lines (58 loc) · 2.9 KB
Raw

✳️ 🌠 ✨ 💫 🌟 🌟 ✨ Contributing ✨ ⭐ 🌟 💫 ✨ 🌠 ✳️

So, you want to contribute to this project! That's awesome. However, before doing so, please read the following simple steps how to contribute. This will make the life easier and will avoid wasting time on things which are not requested. ✨

Discuss the changes before doing them

  • First of all, open an issue in the repository, using the issue panel, describing the contribution you would like to make, the bug you found or any other ideas you have. This will help us to get you started on the right foot.

  • If it makes sense, add the platform and software information (e.g. operating system, Node.JS version etc.), screenshots (so we can see what you are seeing).

  • It is recommended to wait for feedback before continuing to next steps. However, if the issue is clear (e.g. a typo) and the fix is simple, you can continue and fix it.

Fixing issues

  • Fork the project in your account and create a branch with your fix: some-great-feature or some-issue-fix.

  • Commit your changes in that branch. If the project contains tests (generally, the test directory), you are encouraged to add a test as well. 📝

  • If the project contains a package.json or a bower.json file add yourself in the contributors array (or authors in the case of bower.json; if the array does not exist, create it):

    {
   "contributors": [
      "Your Name <[email protected]> (http://your.website)"
   ]
}

Commits

  • Adding commits at stages of work help in understanding the work flow better.
  • Try to make specific commits for the files, just don't add all to the stage at once and commit together.
  • Try to follow the following syntax for the commits
Type: Message of the commit
  • Type can be 'Bug-fix', 'Doc-edit', 'Fix', etc
  • Message should be a one-liner that describes the edit that has been done
Doc-edit: added the contributing guildelines
  • Make sure to capitalise the First letter of the Type and Message for the writing beauty

Creating a pull request

  • Open a pull request, and reference the initial issue in the pull request message (e.g. fixes #). Write a good description and title, so everybody will know what is fixed/improved.

  • If it makes sense, add screenshots, gifs etc., so it is easier to see what is going on.

Wait for feedback

Before accepting your contributions, we will review them. You may get feedback about what should be fixed in your modified code. If so, just keep committing in your branch and the pull request will be updated automatically.

Everyone is happy!

Finally, your contributions will be merged, and everyone will be happy! 😄 Contributions are more than welcome!

Thanks! 😅