Contributing to Open Source Guides
Thanks for checking out the Open Source Guides! We're excited to hear and learn from you. Your experiences will benefit others who read and use these guides.
We've put together the following guidelines to help you figure out where you can best be helpful.
Table of Contents
- Types of contributions we're looking for
- Ground rules & expectations
- How to contribute
- Style guide
- Setting up your environment
- Contribution review process
Types of contributions we're looking for
There are many ways you can directly contribute to the guides (in descending order of need):
- Fix editorial inconsistencies or inaccuracies
- Add stories, examples, or anecdotes that help illustrate a point
- Revise language to be more approachable and friendly
- Translate guides into other languages
Interested in making a contribution? Read on!
Ground rules & expectations
Before we get started, here are a few things we expect from you (and that you should expect from others):
- Be kind and thoughtful in your conversations around this project. We all come from different backgrounds and projects, which means we likely have different perspectives on "how open source is done." Try to listen to others rather than convince them that your way is correct.
- Open Source Guides are released with a Contributor Code of Conduct. By participating in this project, you agree to abide by its terms.
- If you open a pull request, please ensure that your contribution passes all tests. If there are test failures, you will need to address them before we can merge your contribution.
- When adding content, please consider if it is widely valuable. Please don't add references or links to things you or your employer have created as others will do so if they appreciate it.
How to contribute
If you don't see your idea listed, and you think it fits into the goals of this guide, do one of the following:
- If your contribution is minor, such as a typo fix, open a pull request.
- If your contribution is major, such as a new guide, start by opening an issue first. That way, other people can weigh in on the discussion before you do any work.
If you're writing content, see the style guide to help your prose match the rest of the Guides.
Setting up your environment
Once you have that set up, run:
…and open http://localhost:4000 in your web browser.
Discussions about the Open Source Guides take place on this repository's Issues and Pull Requests sections. Anybody is welcome to join these conversations. There is also a mailing list for regular updates.
Wherever possible, do not take these conversations to private channels, including contacting the maintainers directly. Keeping communication public means everybody can benefit and learn from the conversation.