Update docs/CONTRIBUTING.md

This commit is contained in:
Ben Balter 2017-10-24 10:41:23 -04:00
parent 8f534cb3bd
commit ce8bbcb841
1 changed files with 8 additions and 5 deletions

View File

@ -1,12 +1,15 @@
# Contributing to the Hacker theme
# Contributing to The Hacker Theme
Hi there! We're thrilled that you'd like to contribute to the Hacker theme. Your help is essential for keeping it great.
Hi there! We're thrilled that you'd like to contribute to The Hacker Theme. Your help is essential for keeping it great.
the Hacker theme is an open source project supported by the efforts of an entire community and built one contribution at a time by users like you. We'd love for you to get involved. Whatever your level of skill or however much time you can give, your contribution is greatly appreciated. There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests, helping other users by commenting on issues, or writing code which can be incorporated into the Hacker theme itself.
The Hacker Theme is an open source project supported by the efforts of an entire community and built one contribution at a time by users like you. We'd love for you to get involved. Whatever your level of skill or however much time you can give, your contribution is greatly appreciated. There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests, helping other users by commenting on issues, or writing code which can be incorporated into The Hacker Theme itself.
Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.
## Looking for support?
We'd love to help. Check out [the support guidelines](SUPPORT.md).
## How to report a bug
@ -25,7 +28,7 @@ Here are a few tips for writing *great* bug reports:
## How to suggest a feature or enhancement
If you find yourself wishing for a feature that doesn't exist in the Hacker theme, you are probably not alone. There are bound to be others out there with similar needs. Many of the features that the Hacker theme has today have been added because our users saw the need.
If you find yourself wishing for a feature that doesn't exist in The Hacker Theme, you are probably not alone. There are bound to be others out there with similar needs. Many of the features that The Hacker Theme has today have been added because our users saw the need.
Feature requests are welcome. But take a moment to find out whether your idea fits with the scope and goals of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Please provide as much detail and context as possible, including describing the problem you're trying to solve.
@ -35,7 +38,7 @@ Feature requests are welcome. But take a moment to find out whether your idea fi
## Your first contribution
We'd love for you to contribute to the project. Unsure where to begin contributing to the Hacker theme? You can start by looking through these "good first issue" and "help wanted" issues:
We'd love for you to contribute to the project. Unsure where to begin contributing to The Hacker Theme? You can start by looking through these "good first issue" and "help wanted" issues:
* [Good first issues](https://github.com/pages-themes/hacker/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) - issues which should only require a few lines of code and a test or two
* [Help wanted issues](https://github.com/pages-themes/hacker/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) - issues which may be a bit more involved, but are specifically seeking community contributions