Skip to content

Latest commit

 

History

History
48 lines (29 loc) · 1.73 KB

CONTRIBUTING.md

File metadata and controls

48 lines (29 loc) · 1.73 KB
Raw

Contributing Guide

Please follow the instructions on this guide when making contributions to the project

Issues

Issues are very valuable to this project.

  • Ideas are a valuable source of contributions others can make
  • Problems show where this project is lacking
  • With a question you show where contributors can improve the user experience

Thank you for creating them.

Pull Requests

Pull requests are, a great way to get your ideas into this repository.

When deciding if I merge in a pull request I look at the following things:

Does it state intent

You should be clear which problem you're trying to solve with your contribution.

Is it of good quality

  • There are no spelling mistakes
  • It reads well
  • For english language contributions: Has a good score on Grammarly or Hemingway App

Does it move this repository closer to my vision for the repository

The aim of this repository is:

  • To provide a README.md and assorted documents anyone can copy and paste, into their project
  • The content is usable by someone who hasn't written something like this before
  • Foster a culture of respect and gratitude in the open source community.

Guidelines

Create an Issue

If you want to make a contribution, whether to fix a bug, or to add a new feature, first create an issue if it doesn't already exist, outlining briefly what needs to be accomplished/fixed.

Create a Branch

Create a branch for the contribution you are making. If some bug is to be fix or something else, come up with some descriptive yet concise name for the branch.

Write Code

Now write your code to implement your feature. You can commit and push to the dedicated branch as often and whenever you like.