Update CONTRIBUTING.md #24
Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates the CONTRIBUTING.md file to provide a more comprehensive and user-friendly guide for contributors. The changes expand documentation on contribution methods and streamline the technical setup instructions.
Key changes:
- Adds multiple contribution pathways (rating pages, forum posts, Jira tickets) before diving into technical edits
- Reorganizes content to remove detailed build instructions and repository structure documentation
- Improves clarity and grammar throughout the document
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <[email protected]>
nastena1606
temporarily deployed
to
rasika-chivate-patch-1 - plm-docs PR #24
Render
Destroyed
Co-authored-by: Copilot <[email protected]>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated 5 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <[email protected]>
nastena1606
temporarily deployed
to
rasika-chivate-patch-1 - plm-docs PR #24
Render
Destroyed
Co-authored-by: Copilot <[email protected]>
nastena1606
temporarily deployed
to
rasika-chivate-patch-1 - plm-docs PR #24
Render
Destroyed
Co-authored-by: Copilot <[email protected]>
nastena1606
left a comment
nastena1606
left a comment
There was a problem hiding this comment.
Why have you excluded all build steps? HTML builds are valid and I think we should provide them. Only PDFs are irrelevant since we have no PDFs in PCSM quite just yet
CONTRIBUTING.md
Outdated
| - Select the **Create a new branch for this commit and start a pull request** option | ||
| - Click **Propose changes**. | ||
| >[!Important] | ||
| If you’d like the documentation team to fix or improve something, please leave **clear and detailed comments**. This helps us understand the issue faster and address it more efficiently. |
There was a problem hiding this comment.
I still think the message is wrong. I'd start with Help us improve the documetation faster, please leave ....
There was a problem hiding this comment.
Or we can omit this callout altogether, You say the same thing in "Detailed comments are essential" item.
Co-authored-by: Anastasia Alexandrova <[email protected]>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <[email protected]>
Update the contributing guide.