You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/contributors.md
+9-9Lines changed: 9 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -22,11 +22,11 @@ Documentation contributions of any size are welcome! Feel free to contribute eve
22
22
23
23
**How to contribute:**
24
24
25
-
Pull requests are the easiest way to contribute changes to git repos at GitHub. They are the preferred contribution method, as they offer a nice way of commenting and amending the proposed changes.
25
+
Pull requests are the easiest way to contribute changes to git repos at GitHub. They are the preferred contribution method, as they offer a convenient way of commenting and amending the proposed changes.
26
26
27
-
- Please check that no one else has already created a pull request with these changes
27
+
- Please check that no one else has already created a pull request with these or similar changes
28
28
- Use a "feature branch" for your changes. That separates the changes in the pull request from your other changes and makes it easy to edit/amend commits in the pull request
29
-
- Make sure your changes are formatted correctly and consistently with the rest of the documentation
29
+
- Make sure your changes are formatted properly and consistently with the rest of the documentation
30
30
- Re-read what you wrote, and run a spellchecker on it to make sure you didn't miss anything
31
31
- If your pull request is connected to an open issue, please, leave a link to this issue in the `Related issue:` section
32
32
- If you later need to add new commits to the pull request, you can simply commit the changes to the local branch and then push them. The pull request gets automatically updated
@@ -35,7 +35,7 @@ Pull requests are the easiest way to contribute changes to git repos at GitHub.
35
35
36
36
- Maintainers will review your pull request
37
37
- If a maintainer requests changes, first of all, try to think about this request critically and only after that implement and request another review
38
-
- If your PR gets accepted, it will soon be merged into the main branch. But your contribution will take effect only after the release of a new version of the action
38
+
- If your PR gets accepted, it will soon be merged into the main branch. But your contribution will take effect only after the release of a new version of the action and updating the major tag
39
39
> Sometimes maintainers reject pull requests and that's ok! Usually, along with rejection, we supply the reason for it. Nonetheless, we still really appreciate you taking the time to do it, and we don't take that lightly :heart:
40
40
41
41
## Contribute code
@@ -48,9 +48,9 @@ The main difference between code contributions and documentation contributions i
48
48
49
49
**How to contribute:**
50
50
51
-
Pull requests are the easiest way to contribute changes to git repos at GitHub. They are the preferred contribution method, as they offer a nice way of commenting and amending the proposed changes.
51
+
Pull requests are the easiest way to contribute changes to git repos at GitHub. They are the preferred contribution method, as they offer a convenient way of commenting and amending the proposed changes.
52
52
53
-
- Please check that no one else has already created a pull request with these changes
53
+
- Please check that no one else has already created a pull request with these or similar changes
54
54
- Use a "feature branch" for your changes. That separates the changes in the pull request from your other changes and makes it easy to edit/amend commits in the pull request
55
55
- Make sure your changes are well formatted and that all tests are passing
56
56
- If your pull request is connected to an open issue, please, leave a link to this issue in the `Related issue:` section
@@ -65,7 +65,7 @@ Pull requests are the easiest way to contribute changes to git repos at GitHub.
65
65
**Learn more about how to implement tests:**
66
66
67
67
Adding or changing tests is an integral part of making a change to the code.
68
-
Unit tests are in the `__tests__` folder, and end-to-end tests are in the `workflows` folder (in particular, in the file [e2e-cache.yml](https://github.com/actions/setup-python/blob/main/.github/workflows/e2e-cache.yml)).
68
+
Unit tests are in the `__tests__` folder, and end-to-end tests are in the `workflows` folder (in the particular file [e2e-cache.yml](https://github.com/actions/setup-python/blob/main/.github/workflows/e2e-cache.yml)).
69
69
70
70
- The contributor can add various types of tests (like unit tests or end-to-end tests), which, in his opinion, will be necessary and sufficient for testing new or changed functionality
71
71
- Tests should cover a successful execution, as well as some edge cases and possible errors
@@ -76,7 +76,7 @@ Unit tests are in the `__tests__` folder, and end-to-end tests are in the `workf
76
76
- CI will start automatically with some checks. Wait until the end of the execution and make sure that all checks passed successfully. If some checks fail, you can open them one by one, try to find the reason for failing and make changes to your code to resolve the problem
77
77
- Maintainers will review your pull request
78
78
- If a maintainer requests changes, first of all, try to think about his request critically and only after that implement and request another review
79
-
- If your PR gets accepted, it will soon be merged into the main branch. But your contribution will take effect only after the release of a new version of the action
79
+
- If your PR gets accepted, it will soon be merged into the main branch. But your contribution will take effect only after the release of a new version of the action and updating the major tag
80
80
> Sometimes maintainers reject pull requests and that's ok! Usually, along with rejection, we supply the reason for it. Nonetheless, we still really appreciate you taking the time to do it, and we don't take that lightly :heart:
81
81
82
82
## Provide support on issues
@@ -102,7 +102,7 @@ Helping out other users with their questions is an awesome way of contributing t
102
102
## Review pull requests
103
103
104
104
105
-
Another great way to contribute is pull request reviews. Please, be extra kind: people who submit code/doc contributions are putting themselves in a pretty vulnerable position, and have put time and care into what they've done (even if that's not obvious to you!) Please, always respond with respect, and be understanding, but don't feel like you need to sacrifice your standards for their sake, either.
105
+
Another great way to contribute is to review pull request. Please, be extra kind: people who submit code/doc contributions are putting themselves in a pretty vulnerable position, and have put time and care into what they've done (even if that's not obvious to you!) Please, always respond with respect, and be understanding, but don't feel like you need to sacrifice your standards for their sake, either.
0 commit comments