Skip to content

Commit b1a6e8f

Browse files
fix(docs): Correct typo and grammar in CONTRIBUTING.md (#252)
1 parent 4107fdd commit b1a6e8f

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ We appreciate all kinds of contributions to this project. This document gives yo
66

77
- We suggest to follow the common workflow based on issues and pull requests. In the issue, you should describe the problem. Based on this discussion, one can create a pull request that should solve the issue.
88
- A good issue describes what is wrong and why it is wrong. Ideally, one has already a suggestion on how to fix the problem, but the suggestions is not mandatory.
9-
- A good pull request should refer to the issue and thus to the problem that it should solve. Explain what the pull request does and how it addresses the problem/issue. If you still work on a new feature or a fix, you can open a pull request and mark is as draft. Once you consider the work done, please mark it as ready for review and request a reviewer. We will give feedback and eventually merge the pull request.
9+
- A good pull request should refer to the issue and thus to the problem that it should solve. Explain what the pull request does and how it addresses the problem/issue. If you are still working on a new feature or a fix, you can open a pull request and mark it as draft. Once you consider the work done, please mark it as ready for review and request a reviewer. We will give feedback and eventually merge the pull request.
1010
- We enforce consistency of the formatting via automatic style checking. When marking a pull request as ready for review, please make sure that all checks pass successfully.
1111
- For *small changes*, such as typos, broken links etc., please directly create a pull request.
1212
- For larger changes, such as the description of new tools, a new chapter etc., please open an issue first.

0 commit comments

Comments
 (0)