Update CONTRIBUTING.md for clarity and consistency#1550
Update CONTRIBUTING.md for clarity and consistency#1550Joana-Mansa wants to merge 1 commit intocanonical:mainfrom
Conversation
Clarify language and improve readability in contributing guidelines. line 16 - changed pull request to Pull Request (PR) Line 51 specified the it - refers to the signed agreement
edibotopic
left a comment
edibotopic
left a comment
There was a problem hiding this comment.
I've suggested some minor changes to this PR.
I believe you plan to apply some changes suggested in canonical/open-documentation-academy#331 also, which can be tied into this PR too.
Please let me know if anything needs to be clarified.
| The documentation for the Ubuntu WSL distro and Pro for WSL is maintained [here](https://github.com/canonical/ubuntu-pro-for-wsl/tree/main/docs). | ||
|
|
||
| You can contribute to the documentation in various different ways. If you are not a developer but want to help make the product better then helping us to improve the documentation is a way to achieve that. | ||
| You can contribute to the documentation in various different ways. If you are not a developer but want to help make the product better, then helping us to improve the documentation is a way to achieve that. |
There was a problem hiding this comment.
| You can contribute to the documentation in various different ways. If you are not a developer but want to help make the product better, then helping us to improve the documentation is a way to achieve that. | |
| You can contribute to the documentation in various different ways. If you are not a developer but want to help make the product better, helping us to improve the documentation is a way to achieve that. |
With the comma, I think the "then" is no longer needed.
|
|
||
| These are mostly guidelines, not rules. Use your best judgement and feel free to | ||
| propose changes to this document in a pull request. | ||
| propose changes to this document in a Pull Request (PR). |
There was a problem hiding this comment.
propose changes to this document in a Pull Request (PR).
An acronym or initialism should generally be defined on first usage.
I don't think this is the first usage?
Subsequently, the abbreviated form can be used, unless there is a risk of confusion.
Also, even if it is used elsewhere, I don't think it's necessary to capitalize the first letters in pull requests.
Please revisit the page with the above comments in mind.
There was a problem hiding this comment.
I would double-check. Thank you for the feedback
| sign it again. | ||
|
|
||
| An automated test is executed on PRs to check if it has been accepted. | ||
| An automated test is executed on PRs to check if it(your signed agreement) has been accepted. |
There was a problem hiding this comment.
| An automated test is executed on PRs to check if it(your signed agreement) has been accepted. | |
| An automated CLA test is executed on PRs. | |
| This checks whether a contributor has previously signed the CLA. |
The original wording could potentially mislead people, so I've rewritten slightly. The CLA is signed once, then the fact that the user has previously signed a CLA is associated with their account. The check confirms that association and doesn't require any further signing or anyone behind the scenes checking the signature.
|
@Joana-Mansa --- just checking in: any update on your progress with this PR? |
2 participants
Clarify language and improve readability in contributing guidelines. line 16 - changed pull request to Pull Request (PR)
Line 51 specified the it - refers to the signed agreement