Language improvements #72
Conversation
diemol
left a comment
diemol
left a comment
There was a problem hiding this comment.
Thank you, @discombobulateme!
Just a couple of comments.
content/docs/contributing.md
Outdated
| ### Summary | ||
|
|
||
| We highly encourage contributions to existing open source projects. There are some requirements before you start patching, and guides to help you figure out the right path: | ||
| We highly encourage contributions to [existing open source projects](https://opensource.saucelabs.com/projects/). |
There was a problem hiding this comment.
The original phrase was meant to say that OSPO encourages contributions to any project that is open source, given that the guidelines are respected.
The new phrase suggests contributing only to the open source projects featured in our OSS website.
There was a problem hiding this comment.
What do you think about this phrase? The idea behind this change was to easier the path between the wish and a project :)
We highly encourage contributions to any project that is open source, given that the guidelines are respected. Don't know where to start? Here you can find Sauce Labs open source projects and here you can find a list of Open Source projects which support underrepresented groups and where you can participate.
There was a problem hiding this comment.
I'd prefer more something along: "We highly encourage contributions to any open source project that aligns with the guidelines. If you are looking for projects to contribute, here are some suggestions: ...", and then a list of links of projects that we want to suggest.
content/docs/contributing.md
Outdated
| - Patches generally don't require any review from the Open Source Program Office | ||
| There are some requirements before you start patching, and guides to help you figure out the right path: | ||
|
|
||
| - [Patches](https://semver.org/) generally don't require any review from the Open Source Program Office |
There was a problem hiding this comment.
The original meaning is not tied to semver, but to the general meaning of what a patch is.
There was a problem hiding this comment.
Makes super sense! I will change the link :) thank you for checking!
|
Just pushed the changes suggested by @diemol :) |
* Make text more clear and easy to understand * Make text shorter and easier to understand * Change phrase to avoid the usage of 'common sense' * Add link to existing open source projects * Add link to SemVer about what is a patch * Add Advocating and a link explaining how to * Add link to best practices guide * Change phrase to avoid bilateral adjective 'good' * Add phrase to add value to sharing * Change title to avoid confusion w/ our projects * Change phrase to make it smaller and clearer * Make heading smaller * Fix typo * Fix spacing * Add line between paragraph and fix spacing on bullets * Fix spacing in bullets * Fix spacing * Delete line with wrong spacing * Change link to what is a patch * Change text to a more general approach about OS projects 47ea4bc
3 participants
Suggested several small improvements in texts, making them smaller and avoiding dubious adjectives such as: good citizens and common sense.
Added links to better explain some terminologies
Suggested a new title from Projects to Open Sauce Projects to promote the project and differentiate our projects from the ones we support