Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Create contributing doc #227

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Create contributing doc #227

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
## How to contribute to Git-Reflow

Pull requests are welcome. We use this tool every single day and as long as what you want to add doesn't change our workflow, we are happy to accept your updates. General process for contributing changes:
1. [Fork gitreflow](https://github.com/reenhanced/gitreflow/new/master#fork-destination-box). Learn [more about forks here](https://help.github.com/articles/working-with-forks/).
2. Make your changes and push them to your new fork.
3. Please make sure your changes are supported with tests and that they pass.
4. [Submit a Pull Request on GitHub](https://help.github.com/articles/creating-a-pull-request-from-a-fork/).
5. Our core team will review your code and may request changes. If you would prefer us to make the changes for you, feel free to [permit us to do so](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) and we'll update on your behalf.
6. Once the code has been approved, we will merge your PR and bundle the changes into our next release of the gem.

#### **Did you find a bug?**

* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/reenhanced/gitreflow/issues).

* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/reenhanced/gitreflow/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring.

#### **Did you write a patch that fixes a bug?**

* Open a new GitHub pull request with the patch.

* Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.

#### **Do you intend to add a new feature or change an existing one?**

* Suggest your change by [opening an issue on GitHub](https://github.com/reenhanced/gitreflow/issues/new).

* Do not open a PR on GitHub until you have collected positive feedback about the change.

#### **Do you have questions about the source code?**

* Ask any question about how to use Git-Reflow, or how to customize it for your team by opening a new issue on GitHub. We will use our conversation to create wikis and documentation to help others as well.

#### **Do you want to contribute to the Git-Reflow documentation?**

* We use [Yard](https://www.rubydoc.info/gems/yard/file/docs/GettingStarted.md) to document our source code. You can see a [full list of where we could use some help here](https://inch-ci.org/github/reenhanced/gitreflow).

Git-Reflow is a volunteer effort. We encourage you to pitch in and [join the team](https://github.com/reenhanced/gitreflow/graphs/contributors)!

Thanks! :heart: :heart: :heart:

Git-Reflow Team