Skip to content

add error policy to CONTRIBUTING.md #1501

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

Merged
merged 1 commit into from
Jun 12, 2016
Merged

add error policy to CONTRIBUTING.md #1501

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
10 changes: 8 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,16 @@
* Pull Requests should be tested, if feasible:
- bugfixes should include regression tests
- new behavior should at least get minimal exercise
* Use a descriptive prefix for your PR: ENH, FIX, TST, DOC, STY, REF (refactor), WIP (Work in progress)
* After submiting the PR, include an update to the CHANGES file: prefix: description (URL of pull request)
* Use a descriptive prefix for your PR: ENH (enhancement), FIX, TST, DOC, STY, REF (refactor), WIP (Work in progress)
* After submitting the PR, include an update to the CHANGES file: prefix: description (URL of pull request)
* `make specs`
* do: `make check-before-commit` before submitting the PR. This will require you to either install or be in developer mode with: `python setup.py install/develop`.
* In general, do not catch exceptions without good reason.
* catching non-fatal exceptions.
Log the exception as a warning.
* adding more information about what may have caused the error.
Raise a new exception using ``raise_from(NewException("message"), oldException)`` from ``future``.
Do not log this, as it creates redundant/confusing logs.

## Contributing issues

Expand Down