diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2ff8401..5867fee 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,121 +1 @@ -# Contributing to Sage - -Please take a moment to review this document in order to make the contribution -process easy and effective for everyone involved. - -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 or assessing -patches and features. - - -## Using the issue tracker - -The issue tracker is the preferred channel for [bug reports](#bugs), -[features requests](#features) and [submitting pull -requests](#pull-requests), but please respect the following restrictions: - -* Please **do not** use the issue tracker for personal support requests (use the - [Roots Discourse](http://discourse.roots.io/)). - -* Please **do not** derail or troll issues. Keep the discussion on topic and - respect the opinions of others. - - - -## Bug reports - -A bug is a _demonstrable problem_ that is caused by the code in the repository. -Good bug reports are extremely helpful - thank you! - -Guidelines for bug reports: - -1. **Use the GitHub issue search** — check if the issue has already been - reported. - -2. **Check if the issue has been fixed** — try to reproduce it using the - latest `master` or development branch in the repository. - -3. **Isolate the problem to Sage** — make sure that the code in the Sage -repository is _definitely_ responsible for the issue. Switch to a core WordPress -theme (such as Twenty Thirteen) to confirm problems before reporting an issue. -Make sure you have reproduced the bug with all plugins disabled. Any issues -related to HTML5 Boilerplate or Bootstrap should be reported to their respected -repositories and follow their contributing guidelines. - -A good bug report shouldn't leave others needing to chase you up for more -information. Please try to be as detailed as possible in your report. - - - -## Feature requests - -Feature requests are welcome. But take a moment to find out whether your idea -fits with the scope and aims of Sage. It's up to *you* to make a strong -case to convince the Roots developers of the merits of this feature. Please -provide as much detail and context as possible. - - - -## Pull requests - -Good pull requests - patches, improvements, new features - are a fantastic -help. They should remain focused in scope and avoid containing unrelated -commits. - -**Please ask first** before embarking on any significant pull request (e.g. -implementing features, refactoring code), otherwise you risk spending a lot of -time working on something that the developers might not want to merge into Sage. - -Please adhere to the coding conventions used throughout the project (indentation, -comments, etc.). - -Adhering to the following this process is the best way to get your work -included in Sage: - -1. [Fork](http://help.github.com/fork-a-repo/) Sage, clone your fork, - and configure the remotes: - - ```bash - # Clone your fork of the repo into the current directory - git clone https://github.com// - # Navigate to the newly cloned directory - cd - # Assign the original repo to a remote called "upstream" - git remote add upstream https://github.com// - ``` - -2. If you cloned a while ago, get the latest changes from upstream: - - ```bash - git checkout - git pull upstream - ``` - -3. Create a new topic branch (off the main project development branch) to - contain your feature, change, or fix: - - ```bash - git checkout -b - ``` - -4. Commit your changes in logical chunks. Please adhere to these [git commit - message guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) - or your code is unlikely be merged into the main project. Use Git's - [interactive rebase](https://help.github.com/articles/interactive-rebase) - feature to tidy up your commits before making them public. - -5. Locally merge (or rebase) the upstream development branch into your topic branch: - - ```bash - git pull [--rebase] upstream - ``` - -6. Push your topic branch up to your fork: - - ```bash - git push origin - ``` - -10. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/) - with a clear title and description. +Please read [Contributing to Roots Projects](https://github.com/roots/guidelines/blob/master/CONTRIBUTING.md)