Permalink
Browse files

Update CONTRIBUTING.md

  • Loading branch information...
xdamman committed Jun 16, 2016
1 parent b24aeef commit 450fb899604beb15cffed7c48590cb77632868b6
Showing with 30 additions and 2 deletions.
  1. +30 −2 CONTRIBUTING.md
View
@@ -1,7 +1,8 @@
OpenCollective is an open source project and we love to receive contributions from our community — you!
# Introduction
Thank you for considering contributing to OpenCollective! It's people like you that make OpenCollective such a great community.
OpenCollective is an open source project and we love to receive contributions from our community — you!
First, thank you for considering contributing to OpenCollective! It's people like you that make OpenCollective such a great community.
We welcome any type of contribution, not only code. You can help with
- **QA**: file bug reports, the more details you can give the better (e.g. screenshots with the console open)
@@ -10,3 +11,30 @@ We welcome any type of contribution, not only code. You can help with
- **Internationalization**: [translating the interface](https://github.com/OpenCollective/OpenCollective/wiki/Strings)
- **Design**: many collectives don't have a logo or a background image for their hero. Create an issue for it and submit your proposal. We always give credit where credit is due.
- **Code**: there are plenty of [open issues](https://github.com/OpenCollective/OpenCollective/issues). Even if you can't write code, commenting on them, showing that you care about a given issue matters. It helps us triage them.
# Your First Contribution
Unsure where to begin contributing to OpenCollective? You can start by looking through these beginner and help-wanted issues:
[Beginner issues](https://github.com/OpenCollective/OpenCollective/issues?q=is%3Aissue+is%3Aopen+label%3A%22beginner%22+sort%3Acomments-desc) - issues which should only require a few lines of code, and a test or two.
[Help wanted issues](https://github.com/OpenCollective/OpenCollective/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22+sort%3Acomments-desc) - issues which should be a bit more involved than beginner issues.
Both issue lists are sorted by total number of comments. While not perfect, number of comments is a reasonable proxy for impact a given change will have.
Working on your first Pull Request? You can learn how from this *free* series, [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github).
# Submitting code
Any code change should be submitted as a pull request. The description should explain what the code does and give steps to execute it. The pull request should also contain tests.
# Code review process
The bigger the pull request, the longer it will take to review and merge. Try to break down large pull requests in smaller chunks that are easier to review and merge.
If it's a bug fix, it will probably be quickly merged and deployed. If it's a new feature, we will probably ask to limit it to your own collective as a start to see how it goes before releasing it to all other collectives.
# Questions
If you have any questions, reach out to us on [Slack](https://slack.opencollective.com) or [Gitter](https://gitter.im/OpenCollective/OpenCollective).
# Credits
This `CONTRIBUTING.md` is based on @nayafia's template https://github.com/nayafia/contributing-template

0 comments on commit 450fb89

Please sign in to comment.