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 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:
You should be clear which problem you're trying to solve with your contribution.
For example:
Add link to code of conduct in README.md
Doesn't tell me anything about why you're doing that
Add link to code of conduct in README.md because users don't always look in the CONTRIBUTING.md
Tells me the problem that you have found, and the pull request shows me the action you have taken to solve it.
- There are no spelling mistakes
- It reads well
- For english language contributions: Has a good score on Grammarly or Hemingway App
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.
This repository has a code of conduct, I will remove things that do not respect it.
| Type | Description |
|---|---|
| build | The build type (formerly known as chore) is used to identify development changes related to the build system (involving scripts, configurations or tools) and package dependencies. |
| ci | The ci type is used to identify development changes related to the continuous integration and deployment system - involving scripts, configurations or tools. |
| docs | The docs type is used to identify documentation changes related to the project - whether intended externally for the end users (in case of a library) or internally for the developers. |
| feat | The feat type is used to identify production changes related to new backward-compatible abilities or functionality. |
| fix | The fix type is used to identify production changes related to backward-compatible bug fixes. |
| perf | The perf type is used to identify production changes related to backward-compatible performance improvements. |
| refactor | The refactor type is used to identify development changes related to modifying the codebase, which neither adds a feature nor fixes a bug - such as removing redundant code, simplifying the code, renaming variables, etc. |
| revert | For commits that revert one or more previous commits. |
| style | The style type is used to identify development changes related to styling the codebase, regardless of the meaning - such as indentations, semi-colons, quotes, trailing commas and so on. |
| test | The test type is used to identify development changes related to tests - such as refactoring existing tests or adding new tests. |