cpp-lln-lab / CPP_LabGuide

https://cpp-lln-lab.github.io/CPP_LabGuide/
MIT License
2 stars 4 forks source link

imporved readability #17

Closed fcerpe closed 2 months ago

fcerpe commented 2 months ago

Improved readability of the text, with more sequential info on the contributions, links to PR reviewers, and markdown cheatsheet

Summary by Sourcery

Improve the readability and clarity of the contributing guide by restructuring the content, adding a markdown cheatsheet, and providing guidance on selecting reviewers for pull requests.

Documentation:

sourcery-ai[bot] commented 2 months ago

Reviewer's Guide by Sourcery

This pull request improves the readability and structure of the contributing.md file. It provides more detailed and sequential information on how to contribute, adds links to PR reviewers, and mentions a markdown cheatsheet for newcomers.

File-Level Changes

Change Details Files
Restructured and expanded the introduction and contribution process
  • Reworded the introduction to encourage active contribution
  • Added more detailed steps for submitting an issue
  • Expanded the section on making changes yourself
  • Provided a link to a markdown cheatsheet for newcomers
doc/contributing.md
Improved the GitHub editing process explanation
  • Broke down the GitHub editing process into numbered steps
  • Added a step to select a reviewer with specific examples
  • Removed the section about merging the PR immediately
doc/contributing.md
Enhanced clarity and fixed typos
  • Corrected spelling mistakes (e.g., 'incorrenct' to 'incorrect')
  • Improved grammar and sentence structure throughout the document
  • Clarified the location of the website content in the repository
doc/contributing.md

Tips - Trigger a new Sourcery review by commenting `@sourcery-ai review` on the pull request. - Continue your discussion with Sourcery by replying directly to review comments. - You can change your review settings at any time by accessing your [dashboard](https://app.sourcery.ai): - Enable or disable the Sourcery-generated pull request summary or reviewer's guide; - Change the review language; - You can always [contact us](mailto:support@sourcery.ai) if you have any questions or feedback.