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

Update contributing guidelines with reference to Decision Records repo #1720

Merged
merged 1 commit into from
Aug 16, 2017
Merged

Update contributing guidelines with reference to Decision Records repo #1720

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
7 changes: 4 additions & 3 deletions .github/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,14 @@

## Getting started

- Fork the repository on Github
- Fork the repository on GitHub.
- Install the development environment. Follow the instructions in the [README](https://github.com/Cadasta/cadasta-platform/blob/master/README.rst#install-for-development).
- Review our [Contributing Style Guide](https://github.com/Cadasta/cadasta-platform/wiki/Contributing-Style-Guide), [Git Workflow](https://github.com/Cadasta/cadasta-platform/wiki/Git-Workflow), and [Code Layout](https://github.com/Cadasta/cadasta-platform/wiki/Code-layout) documentation. Additional information can be found in our [wiki](https://github.com/Cadasta/cadasta-platform/wiki).
- Review our [Decision Records repository](https://github.com/Cadasta/decision-records) for insight into the approved strategic and architectural plans for the Cadasta Platform.

## Making Changes

- From the `master` create a new branch that will contain all of your work.
- From the `master` branch, create a new branch that will contain all of your work.
- Give your topic branch a meaningful name. For example, if you're working on a bug fix for issue #123, you could call your branch `bugfix/#123`.
- Add tests. Whether you fix a bug or add a new feature, you must add tests to verify your code is working as expected.

Expand All @@ -17,7 +18,7 @@
- Make sure all tests pass. You can run the tests locally using `./runtests.py` in the `/vagrant/` directory.
- Make sure your changes pass checks for coding style. You run the checks locally using `./runtests.py --lint` in the `/vagrant/` directory.
- Give your pull request a meaningful title. The pull request title will end up as the commit message in the commit history. For a bug fix a pull request title could read "Fixes #123 -- Make sure usernames are not case-sensitive".
- If this is a bug fix, link the issue you are addressing in the PR description. Github makes this easy when you type `#123` (123 is the number of the issue) the text is automatically linked.
- If this is a bug fix, link the issue you are addressing in the PR description. GitHub makes this easy when you type `#123` (123 is the number of the issue) the text is automatically linked.
- When you open a new pull request, you will find four questions that help you to provide us the information we need to review your PR. You should respond to the first question (_Proposed changes in this pull request_) sufficiently. Please describe the changes you have made and why you had to make those changes. If your PR fixes a bug, please include a description of the cause of the bug as well.
- You do not need to worry about the checklist in the pull request template. The list helps us to remember important things to look at when reviewing. You can use the list, however, as a guideline to prepare your pull request.

Expand Down