crashkeys.dev
Markdown parser fork with extended syntax for personal use.
1# Contribute
2
3> 👉 **Important**:
4> this project has a [code of conduct][coc].
5> By interacting with this repository and community you agree to abide by its
6> terms.
7
8This article explains how to contribute.
9Please read through the following guidelines.
10
11## Contributions
12
13There are several ways to contribute, not just by writing code.
14See [Support][] if you have questions.
15
16### Financial support
17
18You can help financially.
19See [Sponsor][] for more info.
20
21### Improve docs
22
23As a user you’re perfect to help improve the docs.
24Typo corrections, error fixes, better explanations, new examples, etcetera.
25
26### Improve issues
27
28Some issues lack information, aren’t reproducible, or are just incorrect.
29You can help by trying to make them easier to resolve.
30Existing issues might benefit from your unique experience or opinions.
31
32### Write code
33
34Code contributions are very welcome too.
35It’s probably a good idea to first post a question or open an issue to report a
36bug or suggest a new feature before creating a pull request.
37See [Project][] for more info.
38
39## Submitting an issue
40
41* the issue tracker is for issues, discussions are for questions
42* search the issue tracker (including closed issues) before opening a new
43 issue
44* ensure you’re using the latest versions of packages and other tools
45* use a clear and descriptive title
46* include as much information as possible: steps to reproduce the issue,
47 error message, version, operating system, etcetera
48* the more time you put into an issue, the better help you can get
49* the best issue report is a failing test] proving it
50
51## Submitting a pull request
52
53* run `cargo fmt` and `cargo test` locally to format and test your changes
54* non-trivial changes are often best discussed in an issue first, to prevent
55 you from doing unnecessary work
56* for ambitious tasks, you should try to get your work in front of the
57 community for feedback as soon as possible
58* new features should be accompanied by tests and documentation
59* don’t include unrelated changes
60* write a convincing description of why your pull request should land:
61 it’s your job to be convincing
62
63## Project (for maintainers)
64
65See [Project][project] in the readme for info on how the project is structured
66and how to run useful scripts.
67
68### Release
69
70* update the `version` field in `Cargo.toml`
71* search for the previous version in `readme.md`, replace with new one
72* `git commit --all --message 1.2.3 && git tag 1.2.3 && git push && git push --tags`
73* `cargo publish`
74
75(similar for `mdast_util_to_markdown`)
76
77## Resources
78
79* [how to contribute to open source](https://opensource.guide/how-to-contribute/)
80* [making your first contribution](https://medium.com/@vadimdemedes/making-your-first-contribution-de6576ddb190)
81* [using pull requests](https://help.github.com/articles/about-pull-requests/)
82* [GitHub help](https://help.github.com)
83
84## License
85
86[CC-BY-4.0][license] © [Titus Wormer][author]
87
88<!-- Definitions -->
89
90[license]: https://creativecommons.org/licenses/by/4.0/
91
92[author]: https://wooorm.com
93
94[support]: support.md
95
96[coc]: code-of-conduct.md
97
98[sponsor]: https://github.com/wooorm/markdown-rs/#sponsor
99
100[project]: https://github.com/wooorm/markdown-rs/#project