Skip to content

Commit

Permalink
Update contributing guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
bestwebua committed Apr 8, 2019
1 parent 49b5737 commit d61e0d0
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 9 deletions.
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
### New Issue Checklist

- [ ] I have updated truemail to the latest version
- [ ] I have read the [Contribution Guidelines](CONTRIBUTING.md)
- [ ] I have read the [documentation](README.md)
- [ ] I have read the [Contribution Guidelines](../CONTRIBUTING.md)
- [ ] I have read the [documentation](../README.md)
- [ ] I have searched for [existing GitHub issues](https://github.com/rubygarage/truemail/issues)

### Issue Description
Expand Down
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
- [ ] My code follows the code style of this project
- [ ] My change requires a change to the documentation
- [ ] I have updated the documentation accordingly
- [ ] I have read the [**CONTRIBUTING** document](CONTRIBUTING.md)
- [ ] I have read the [**CONTRIBUTING** document](../CONTRIBUTING.md)
- [ ] I have added tests to cover my changes
- [ ] I have run `bundle exec rspec` from the root directory to see all new and existing tests pass
- [ ] I have run `rubocop` and `reek` to ensure the code style is valid
14 changes: 8 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,9 @@ 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.
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. Truemail [issue template](.github/ISSUE_TEMPLATE.md)

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. What is your environment? What steps will reproduce the issue? What would you expect to be the outcome? All these details will help people to fix any potential bugs.

Expand All @@ -37,7 +38,8 @@ Please adhere to the coding conventions used throughout a project (indentation,

Guidelines for pull requests:

1. Fork the repo.
2. Run the tests. This is to make sure your starting point works. Tests can be run via ```rspec```
3. Create a new branch and make your changes. This includes tests for features!
4. Push to your fork and submit a pull request.
1. Truemail [pull request template](.github/PULL_REQUEST_TEMPLATE.md)
2. Fork the repo
3. Run the tests. This is to make sure your starting point works. Tests can be run via ```rspec```
4. Create a new branch and make your changes. This includes tests for features!
5. Push to your fork and submit a pull request

0 comments on commit d61e0d0

Please sign in to comment.