Skip to content

Commit d7c4c17

Browse files
Update CONTRIBUTING.md
# Contributing to Open Source Guides Thanks for checking out the Open Source Guides! We're excited to hear and learn from you. Your experiences about the Open Source Guides take place on this repository's [Pull Requests](https://github.com/github/opensource.guide/pulls) section. Anybody is welcome to join these conversations. .
1 parent 9b7941d commit d7c4c17

File tree

1 file changed

+73
-0
lines changed

1 file changed

+73
-0
lines changed

CONTRIBUTING.md

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
---
2+
---
23
layout: default
34
---
45

@@ -72,3 +73,75 @@ chmod +x script/server
7273
Discussions about the Open Source Guides take place on this repository's [Pull Requests](https://github.com/github/opensource.guide/pulls) section. Anybody is welcome to join these conversations.
7374

7475
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.
76+
---
77+
78+
# Contributing to Open Source Guides
79+
80+
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.
81+
82+
We've put together the following guidelines to help you figure out where you can best be helpful.
83+
84+
## Table of Contents
85+
86+
0. [Types of contributions we're looking for](#types-of-contributions-were-looking-for)
87+
0. [Ground rules & expectations](#ground-rules--expectations)
88+
0. [How to contribute](#how-to-contribute)
89+
0. [Style guide](#style-guide)
90+
0. [Setting up your environment](#setting-up-your-environment)
91+
0. [Community](#community)
92+
93+
## Types of contributions we're looking for
94+
95+
There are many ways you can directly contribute to the guides (in descending order of need):
96+
97+
* Fix editorial inconsistencies or inaccuracies
98+
* [Translate guides into other languages](docs/translations.md)
99+
100+
Interested in contributing to this Open Source Guide? Read on!
101+
102+
## Ground rules & expectations
103+
104+
Before we get started, here are a few things we expect from you (and that you should expect from others):
105+
106+
* 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.
107+
* Open Source Guides are released with a [Contributor Code of Conduct](./CODE_OF_CONDUCT.md). By participating in this project, you agree to abide by its terms.
108+
* Please ensure that your contribution passes all tests if you open a pull request. If there are test failures, you will need to address them before we can merge your contribution.
109+
* 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.
110+
111+
## How to contribute
112+
113+
If you'd like to contribute, start by searching through the [pull requests](https://github.com/github/opensource.guide/pulls) to see whether someone else has raised a similar idea or question.
114+
115+
If you don't see your idea listed, and you think it fits into the goals of this guide, open a pull request.
116+
117+
## Style guide
118+
119+
If you're writing content, see the [style guide](./docs/styleguide.md) to help your prose match the rest of the guides.
120+
121+
## Setting up your environment
122+
123+
This site is powered by [Jekyll](https://jekyllrb.com/). Running it on your local machine requires a working [Ruby](https://www.ruby-lang.org/en/) installation with [Bundler](https://bundler.io/) along with [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm).
124+
125+
Once you have that set up:
126+
127+
1. Grant execution permissions to the scripts:
128+
129+
```bash
130+
chmod +x script/bootstrap
131+
chmod +x script/server
132+
```
133+
134+
2. Execute the scripts:
135+
136+
```bash
137+
./script/bootstrap
138+
./script/server
139+
```
140+
141+
…and open <http://localhost:4000> in your web browser.
142+
143+
## Community
144+
145+
Discussions about the Open Source Guides take place on this repository's [Pull Requests](https://github.com/github/opensource.guide/pulls) section. Anybody is welcome to join these conversations.
146+
147+
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.

0 commit comments

Comments
 (0)