Skip to content

Commit e0ca3f6

Browse files
committed
Refactor docs
1 parent d399853 commit e0ca3f6

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

62 files changed

+1833
-1798
lines changed

.github/contribute.md

Lines changed: 28 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Contribute
22

3-
> 👉 **Important**: this project has a [code of conduct][coc].
3+
> 👉 **Important**:
4+
> this project has a [code of conduct][coc].
45
> By interacting with this repository and community you agree to abide by its
56
> terms.
67
@@ -37,27 +38,27 @@ See [Project][] for more info.
3738

3839
## Submitting an issue
3940

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
4950

5051
## Submitting a pull request
5152

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
6162

6263
## Project (for maintainers)
6364

@@ -66,19 +67,19 @@ and how to run useful scripts.
6667

6768
### Release
6869

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`
7374

7475
(similar for `mdast_util_to_markdown`)
7576

7677
## Resources
7778

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)
8283

8384
## License
8485

.github/support.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -16,20 +16,20 @@ Spend time framing questions and add links and resources.
1616
Spending the extra time up front helps save everyone time in the long run.
1717
Here are some tips:
1818

19-
* see [*How do I ask a good question* by `StackOverflow`][how-to-ask] for a
20-
good guide
21-
* [talk to a duck][rubberduck]!
22-
* don’t fall for the [XY problem][xy]
23-
* search to find out if a similar question has been asked
24-
* try to define what you need help with:
25-
* is there something in particular you want to do?
26-
* what problem are you encountering and what steps have you taken to try
27-
and fix it?
28-
* is there a concept you don’t understand?
29-
* provide sample code, if possible
30-
* screenshots can help, but if there’s important text such as code or error
31-
messages in them, please also provide those as text
32-
* the more time you put into asking your question, the better we can help you
19+
* see [*How do I ask a good question* by `StackOverflow`][how-to-ask] for a
20+
good guide
21+
* [talk to a duck][rubberduck]!
22+
* don’t fall for the [XY problem][xy]
23+
* search to find out if a similar question has been asked
24+
* try to define what you need help with:
25+
* is there something in particular you want to do?
26+
* what problem are you encountering and what steps have you taken to try
27+
and fix it?
28+
* is there a concept you don’t understand?
29+
* provide sample code, if possible
30+
* screenshots can help, but if there’s important text such as code or error
31+
messages in them, please also provide those as text
32+
* the more time you put into asking your question, the better we can help you
3333

3434
## Contributions
3535

generate/src/main.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ async fn punctuation() {
152152
///
153153
/// ## References
154154
///
155-
/// * [*§ 2.1 Characters and lines* in `CommonMark`](https://spec.commonmark.org/0.31.2/#unicode-punctuation-character)
155+
/// * [*§ 2.1 Characters and lines* in `CommonMark`](https://spec.commonmark.org/0.31.2/#unicode-punctuation-character)
156156
pub static PUNCTUATION: [char; {}] = [
157157
{}
158158
];

0 commit comments

Comments
 (0)