From 1109709c584cfad1c53fe69e8aea05edda7e23cf Mon Sep 17 00:00:00 2001 From: Stanislas Michalak Date: Thu, 27 Jun 2019 19:12:18 +0200 Subject: [PATCH] Add more contributing guidelines (#1715) Make sure the rules are clear, and precise we will close non-compliant contributions. Also please don't @ markbates. :D --- .github/CONTRIBUTING.md | 6 +++++- README.md | 10 +++++++++- 2 files changed, 14 insertions(+), 2 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 1a3e894c8..35bff4753 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -28,9 +28,13 @@ Support for Go Modules were introduced in [Release v0.13.0-beta.1](https://githu 4. Make sure tests run when doing `go test ./...`. You may need to do `go get -t ./...` first to get the testing dependencies. 5. (Optional) There is a much longer set of integration tests that can be run. These will be run by Travis-CI when you open a PR. If you want to run them locally, you can by running `docker build .`. +Feel free to ask for help, but don't target a specific person (unless you're replying to this person). e.g. don't @ markbates, but @ gobuffalo/core-managers instead. + ### Making your Pull Request -Open a PR against the `development` branch. **_DO NOT_** open one against `master` unless you are explicitly told to. All "unreleased" work happens in the `development` branch. +Open a PR against the `development` branch. **_DO NOT_** open one against `master`. All "unreleased" work happens in the `development` branch, and we will fix the master branch if necessary. + +**WE WILL CLOSE ANY PR OPENED AGAINST MASTER BRANCH**. ## Documentation Welcome diff --git a/README.md b/README.md index 036d91042..c88e6f7da 100644 --- a/README.md +++ b/README.md @@ -58,4 +58,12 @@ Oh, yeah, everyone wants benchmarks! What would a web framework be without its b First, thank you so much for wanting to contribute! It means so much that you care enough to want to contribute. We appreciate every PR from the smallest of typos to the be biggest of features. -To contribute, please read the contribution guidelines: [CONTRIBUTING](.github/CONTRIBUTING.md) +**Here are the core rules to respect**: +* If you have any question, please consider using the [Slack channel](https://gobuffalo.io/docs/slack) (*#buffalo*, *#buffalo_fr* or *#buffalo-dev* for contribution related questions) or [Stack Overflow](https://stackoverflow.com/questions/tagged/buffalo). We use GitHub issues for **bug reports and feature requests only**. +* All contributors of this project are working on their free time: be patient and kind. :) +* Consider opening an issue **BEFORE** creating a Pull request (PR): you won't loose your time on fixing non-existing bugs, or fixing the wrong bug. Also we can help you to produce the best PR! +* All PRs **MUST** be opened against the *development* branch. If you want to write an hot-fix, we'll first fix the *development* branch before moving the patch to *master* branch. + +**WE WILL CLOSE ANY ISSUE OR PR NOT FOLLOWING THESE CORE RULES**. + +For the full contribution guidelines, please read [CONTRIBUTING](.github/CONTRIBUTING.md).