1
1
# Contribute
2
2
3
- > 👉 ** Important** : this project has a [ code of conduct] [ coc ] .
3
+ > 👉 ** Important** :
4
+ > this project has a [ code of conduct] [ coc ] .
4
5
> By interacting with this repository and community you agree to abide by its
5
6
> terms.
6
7
@@ -37,27 +38,27 @@ See [Project][] for more info.
37
38
38
39
## Submitting an issue
39
40
40
- * the issue tracker is for issues, discussions are for questions
41
- * search the issue tracker (including closed issues) before opening a new
42
- issue
43
- * ensure you’re using the latest versions of packages and other tools
44
- * use a clear and descriptive title
45
- * include as much information as possible: steps to reproduce the issue,
46
- error message, version, operating system, etcetera
47
- * the more time you put into an issue, the better help you can get
48
- * the best issue report is a failing test] proving it
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
49
50
50
51
## Submitting a pull request
51
52
52
- * run ` cargo fmt ` and ` cargo test ` locally to format and test your changes
53
- * non-trivial changes are often best discussed in an issue first, to prevent
54
- you from doing unnecessary work
55
- * for ambitious tasks, you should try to get your work in front of the
56
- community for feedback as soon as possible
57
- * new features should be accompanied by tests and documentation
58
- * don’t include unrelated changes
59
- * write a convincing description of why your pull request should land:
60
- it’s your job to be convincing
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
61
62
62
63
## Project (for maintainers)
63
64
@@ -66,19 +67,19 @@ and how to run useful scripts.
66
67
67
68
### Release
68
69
69
- * update the ` version ` field in ` Cargo.toml `
70
- * search for the previous version in ` readme.md ` , replace with new one
71
- * ` git commit --all --message 1.2.3 && git tag 1.2.3 && git push && git push --tags `
72
- * ` cargo publish `
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 `
73
74
74
75
(similar for ` mdast_util_to_markdown ` )
75
76
76
77
## Resources
77
78
78
- * [ how to contribute to open source] ( https://opensource.guide/how-to-contribute/ )
79
- * [ making your first contribution] ( https://medium.com/@vadimdemedes/making-your-first-contribution-de6576ddb190 )
80
- * [ using pull requests] ( https://help.github.com/articles/about-pull-requests/ )
81
- * [ GitHub help] ( https://help.github.com )
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 )
82
83
83
84
## License
84
85
0 commit comments