|
| 1 | +# Contributing |
| 2 | + |
| 3 | +Interested in contributing? Great! Here are some suggestions to make it a good |
| 4 | +experience: |
| 5 | + |
| 6 | +Start by [opening an issue][github-issues], whether to identify a problem or |
| 7 | +suggest a change. That issue should be used to discuss the situation and agree |
| 8 | +on a plan of action before writing code or sending a pull request. Maybe the |
| 9 | +problem isn't really a problem, or maybe there are other things to consider. If |
| 10 | +so, it's best to realize that before spending time and effort writing code that |
| 11 | +may not get used. |
| 12 | + |
| 13 | +Match the coding style of the files you edit. Although everyone has their own |
| 14 | +preferences and opinions, a pull request is not the right forum to debate them. |
| 15 | + |
| 16 | +Package versions for `dependencies` and `devDependencies` should be specified |
| 17 | +exactly (also known as "pinning"). The short explanation is that doing otherwise |
| 18 | +eventually leads to inconsistent behavior and broken functionality. (See [Pin |
| 19 | +your npm/yarn dependencies][pin-dependencies] for a longer explanation.) |
| 20 | + |
| 21 | +Add tests for all new/changed functionality. Test positive and negative |
| 22 | +scenarios. Try to break the code now, or else it will get broken later. |
| 23 | + |
| 24 | +Run local tests via `npm test`. Lint by running `npm run lint`. The best way to |
| 25 | +test GitHub Actions is via Workflows, so create a (draft) PR to see your changes |
| 26 | +in action. |
| 27 | + |
| 28 | +Pull requests should contain a single commit that addresses a single issue. |
| 29 | + |
| 30 | +Open pull requests against the `main` branch. Include the text "(fixes #??)." at |
| 31 | +the end of the commit message so it will be associated with the corresponding |
| 32 | +issue. (See [the GitHub documentation][linking-pull-request] for details.) |
| 33 | + |
| 34 | +Please refrain from using slang or meaningless placeholder words. Sample content |
| 35 | +can be "text", "code", "heading", or the like. Sample URLs should use |
| 36 | +[example.com][example-com] which is safe for this purpose. Profanity is not |
| 37 | +allowed. |
| 38 | + |
| 39 | +In order to maintain the permissive MIT license this project uses, all |
| 40 | +contributions must be your own and released under that license. Code you add |
| 41 | +should be an original work and should not be copied from elsewhere. Taking code |
| 42 | +from a different project, Stack Overflow, or the like is not allowed. The use of |
| 43 | +tools such as GitHub Copilot, ChatGPT, LLMs (large language models), etc. that |
| 44 | +incorporate code from other projects is not allowed. |
| 45 | + |
| 46 | +Thank you! |
| 47 | + |
| 48 | +[example-com]: https://en.wikipedia.org/wiki/Example.com |
| 49 | +[github-issues]: https://github.com/DavidAnson/markdownlint-cli2/issues |
| 50 | +[linking-pull-request]: https://docs.github.com/en/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword |
| 51 | +[pin-dependencies]: https://maxleiter.com/blog/pin-dependencies |
0 commit comments