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

Add appraisal and foreman commands to docs #877

Merged
merged 3 commits into from
May 9, 2017
Merged

Add appraisal and foreman commands to docs #877

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fe344b2
Add appraisal and foreman commands to docs
May 9, 2017
ca5ef6c
Use auto ordered list in CONTRIBUTING.md
May 9, 2017
121029b
Fix typos in CONTRIBUTING.md
May 9, 2017
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
22 changes: 14 additions & 8 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,27 +10,33 @@ issue trackers, chatrooms, and mailing lists.

1. Fork the repo.

2. Run `./bin/setup`.
1. Run `./bin/setup`.

3. Run the tests. We only take pull requests with passing tests, and it's great
to know that you have a clean slate:
`bundle exec rake && bundle exec appraisal rake`
1. Run `appraisal install`

4. Add a test for your change. Only refactoring and documentation changes
1. Run the tests. We only take pull requests with passing tests, and it's great
to know that you have a clean slate: `bundle exec rake && bundle exec appraisal rake`

1. Add a test for your change. Only refactoring and documentation changes
require no new tests. If you are adding functionality or fixing a bug,
we need a test!

5. Make the test pass.
1. Make the test pass.

6. Write a [good commit message][commit].
1. Write a [good commit message][commit].

7. Push to your fork and submit a pull request.
1. Push to your fork and submit a pull request.

Others will give constructive feedback.
This is a time for discussion and improvements,
and making the necessary changes will be required before we can
merge the contribution.

## Start Application in Development

Configure your local environment with `./bin/setup`.
After that start the application with the `foreman start` command.

## Performance Improvements

Improving our users' experience should be the primary goal of any optimization.
Expand Down