diff --git a/content/docs/_index.md b/content/docs/_index.md index 677334f..4f23091 100644 --- a/content/docs/_index.md +++ b/content/docs/_index.md @@ -4,11 +4,11 @@ date: 2019-06-26T12:14:34+06:00 description: "Sauce Labs Open Source Documentation with guidelines for Open Source best practices and policies." --- -##### Saucers have been using and contributing to open source projects since the company was started, but there is no clear or well-documented guidance on how to engage in open source. Questions about legal issues, licensing and what is deemed confidential or proprietary information are common. +##### Saucers have been using and contributing to open source projects since the company started. Regardless, there was no guidance on how to engage in open source. This is an initiative to clarify questions about legal issues, licensing and what is confidential or proprietary information. ##### The following documents are primarily intended for Saucers - but will also serve as a reference by anyone else - on how to adopt, modify and release open source code. -> This content is inspired by Zalando's Open Source [documentation](https://opensource.zalando.com/docs), which has an [MIT license](https://github.com/zalando/zalando.github.io/blob/master/LICENSE) as well as various of other sources. However, many of the things we do are unique to how Sauce Labs operates and our engineering culture, so these should not be read as "how-to" guides. To hear from more companies deeply involved in open source, we recommend checking out the [TODO Group](https://todogroup.org/). +> This content is mostly inspired by Zalando’s Open Source [documentation](https://opensource.zalando.com/docs). Please consider this as a guideline instead of a how-to, as Sauce Labs operates in a unique way and we have our own engineering culture. To understand more about companies deeply involved in open source, we recommend checking out the [TODO Group](https://todogroup.org/). ### Topics diff --git a/content/docs/contributing.md b/content/docs/contributing.md index 358244f..5f2dcbd 100644 --- a/content/docs/contributing.md +++ b/content/docs/contributing.md @@ -4,15 +4,17 @@ description: "Contributing to Open Source" draft: false --- -Participation in open source projects is highly encouraged, and the Open Source Program Office wants to make this process as simple as possible. All Saucers are expected to follow common sense regarding the type of information and code is contributed to upstream open source projects. If you are in doubt, please reach out to the OSPO or ask your manager for direction. +Participation in open source projects is highly encouraged, and the Open Source Program Office wants to make this process as simple as possible. Saucers are responsible to preserve our valuable information and code. OSPO and your manager can help you understand and determine what is open sourceable and what must remain private. In doubt, always ask. ### 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 any open source project that aligns with the guidelines. If you are looking for projects to contribute, but don't know how to choose, we can help. -- 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://en.wikipedia.org/wiki/Patch_(computing)) generally don't require any review from the Open Source Program Office - Double-check to make certain you are not sharing confidential information -- Ensure your commits are associated with your saucelabs.com email (unless you have a history of contributing to the repo under a different email before your employment at Sauce Labs). [How to associate your commit with a saucelabs.com email.](https://help.github.com/articles/setting-your-email-in-git/) +- Ensure your commits are associated with your saucelabs.com email (unless you have a history of contributing to the repo under a different email before your employment at Sauce Labs). [How to associate your commit with a saucelabs.com email](https://help.github.com/articles/setting-your-email-in-git/). ### Common Contribution Rules @@ -21,8 +23,8 @@ The following criteria must be met when contributing to an open source project: - Only contribute to public repositories on GitHub (or the community GitLab version) that have a permissive, weak copyleft or string copyleft license according to the [license guide](/docs/license-guide) - Do not share Sauce Labs confidential information - Do not contribute code that is proprietary to Sauce Labs and/or a competitive differentiator - - In short, do not reveal our secret sauce. - - When in doubt, check with the OSPO and your manager for additional guidance + - In short, do not reveal our secret sauce. + - When in doubt, check with the OSPO and your manager for additional guidance - Keep in mind that Sauce Labs has legal ownership of the contributions you make while you are a Sauce Labs employee, and CLAs are signed on behalf of Sauce Labs - Only sign [allowlist CLAs](./#whitelisted-clas), please reach out to the OSPO team for advice @@ -34,6 +36,7 @@ Contributions to open source projects such as the following normally do not requ - Writing documentation - Reviewing code - Participating in project maintenance such as creating roadmaps, grooming backlogs, etc. +- [Advocating](https://opensource.org/AdvocateCircle) for your favorite projects by sharing it in social media or, why not, giving talks about it ### Code Contributions diff --git a/content/docs/releasing.md b/content/docs/releasing.md index 1591d3b..f2e82a0 100644 --- a/content/docs/releasing.md +++ b/content/docs/releasing.md @@ -10,7 +10,7 @@ Here you can see the steps that describe how Saucers can release a new open sour Releasing a new open source project is straightforward, just follow these guidelines: - Get approval: ensure you have organizational buy-in from your manager and that it is permissible to open source your project -- Employ best practices: ensure your project follows established and successful practices +- Employ best practices: ensure your project follows established and [successful practices](https://opensource.saucelabs.com/docs/releasing/#use-best-practices) - Prepare your repository: clean up and refactor your code to work outside the Sauce Labs environment - Get reviewed: the Sauce Labs Open Source team can help and will review your project @@ -30,7 +30,8 @@ You cannot publish anything on GitHub that exposes any proprietary company techn If you are in doubt, please reach out to the [Open Source team](https://wiki.saucelabs.com/display/OSS/Open+Source+Team) or ask your manager for instructions. ### Use best practices -Follow the guidelines that are present in many of the most renowned open source projects. By adhering to the items listed below you will be certain to get your roject started on the right foot. + +Follow the guidelines that are present in many of the most renowned open source projects. By adhering to the items listed below you will be certain to get your project started on the right foot. #### Include the required assets Use the [new-project](https://github.com/saucelabs/new-project) template as a boilerplate for the files required for your project. These files are needed to correctly communicate ownership and guidelines for the project: diff --git a/data/homepage.yml b/data/homepage.yml index 946c718..f78f01f 100644 --- a/data/homepage.yml +++ b/data/homepage.yml @@ -88,7 +88,7 @@ values: enable: true title: "Our Values" heading: "Be Open and Act Open" - intro: "Sauce Labs believes in the value of open source practices and leadership. We support and encourage employees across departments to be good open source citizens by participating in communities, sharing our knowledge and promoting open source best practices." + intro: "Sauce Labs believes in the value of open source practices and leadership. We support and encourage employees across departments to be active participants in communities, sharing our knowledge and promoting open source best practices." item: - title: "Participate" image: "/images/icons/participate_3x.svg" @@ -96,7 +96,7 @@ values: - title: "Share" image: "/images/icons/share_3x.svg" - content: "We are eager to share our knowledge, code and practices around automated testing to benefit as many people as possible." + content: "We are eager to share our knowledge, code and practices around automated testing to benefit as many people as possible. The more we share, the more we grow." - title: "Promote" image: "/images/icons/promote_3x.svg" @@ -107,7 +107,7 @@ events: enable: true title: "Events" heading: "Come out and join us" - intro: "We always love to connect! If you happen to be at one of the following events make sure to attend a Sauce Labs speaking session or stop by our booth and say hi." + intro: "We love to connect! If you attend one of the following events meet us in the Sauce Labs speaking session or stop by our booth and say hi." item: - name: "Open Quality Conference" image: "/images/events/qualityconf.gif" @@ -156,7 +156,7 @@ portfolio: # projects open_sauce_projects: enable: true - title: "Projects" + title: "Open Sauce Program" heading: "Open Source projects we support" intro: "Sauce Labs is committed to support the open source ecosystem by providing free licenses through the Open Sauce program." item: @@ -236,9 +236,9 @@ clients_logo_slider: # blog blog: - enable : true - title : "Blog" - heading: "Read and learn more at our blog" + enable: true + title: "Blog" + heading: "Read and learn more" # blog post comes from "content/blog" folder # hiring