2015-01-27 09:59:36 +01:00
|
|
|
# Contributing
|
|
|
|
|
|
|
|
1. Fork the repo.
|
2015-02-23 13:55:40 +01:00
|
|
|
2. Add your section following the [styling guide](#styling). One snippet per PR, please!
|
2015-01-27 09:59:36 +01:00
|
|
|
3. Commit changes.
|
|
|
|
4. Push your commit.
|
|
|
|
5. Create a pull request.
|
|
|
|
6. Wait with your fingers crossed.
|
|
|
|
|
|
|
|
## Styling
|
|
|
|
|
|
|
|
- Put your snippets into corresponding sections.
|
2015-01-27 11:37:22 +01:00
|
|
|
- Put the snippet names into the [Table of Contents](README.md#table-of-contents) and link them using relative URLs.
|
2015-01-27 09:59:36 +01:00
|
|
|
- Use `###` headers for your snippets.
|
2015-02-23 13:31:25 +01:00
|
|
|
- Use [Title Case](https://en.wikipedia.org/wiki/Letter_case#Title_case) for headers.
|
2015-01-27 09:59:36 +01:00
|
|
|
- Add some note/description if applicable. People will thank you for that.
|
2015-01-27 10:01:51 +01:00
|
|
|
- Be grateful. Indicate a source using this format `[Source](link)` if applicable.
|
2015-01-27 09:59:36 +01:00
|
|
|
- For Apache-related examples, wrap your commands in a `apacheconf` code block.
|
2015-02-09 22:23:27 +01:00
|
|
|
- For command-line examples, wrap your commands in a `bash` code block.
|