-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
b184b2d
commit 6946d99
Showing
8 changed files
with
204 additions
and
22 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,74 @@ | ||
# Contributing | ||
|
||
## Getting Started | ||
|
||
* Make sure you have a [GitHub account](https://github.com/signup/free) | ||
* Submit a ticket for your issue, assuming one does not already exist. | ||
* Clearly describe the issue including steps to reproduce when it is a bug. | ||
* Make sure you fill in the earliest version that you know has the issue. | ||
* Fork the repository on GitHub | ||
|
||
|
||
## Making Changes | ||
|
||
* Create a topic branch from where you want to base your work. | ||
* This is usually the master branch. | ||
* Only target release branches if you are certain your fix must be on that | ||
branch. | ||
* To quickly create a topic branch based on master; `git checkout -b | ||
fix/master/my_contribution master`. Please avoid working directly on the | ||
`master` branch. | ||
* Make commits of logical units. | ||
* Check for unnecessary whitespace with `git diff --check` before committing. | ||
* Make sure your commit messages are in the proper format (see below) | ||
* Make sure you have added the necessary tests for your changes. | ||
* Run _all_ the tests to assure nothing else was accidentally broken. | ||
|
||
### Writing the commit message | ||
|
||
Commit messages should be clear and follow a few basic rules. Example: | ||
|
||
``` | ||
ENH: add functionality X to bluesky.<submodule>. | ||
The first line of the commit message starts with a capitalized acronym | ||
(options listed below) indicating what type of commit this is. Then a blank | ||
line, then more text if needed. Lines shouldn't be longer than 72 | ||
characters. If the commit is related to a ticket, indicate that with | ||
"See #3456", "See ticket 3456", "Closes #3456" or similar. | ||
``` | ||
|
||
Describing the motivation for a change, the nature of a bug for bug fixes | ||
or some details on what an enhancement does are also good to include in a | ||
commit message. Messages should be understandable without looking at the code | ||
changes. | ||
|
||
Standard acronyms to start the commit message with are: | ||
``` | ||
API: an (incompatible) API change | ||
BLD: change related to building numpy | ||
BUG: bug fix | ||
CI : continuous integration | ||
DEP: deprecate something, or remove a deprecated object | ||
DEV: development tool or utility | ||
DOC: documentation | ||
ENH: enhancement | ||
MNT: maintenance commit (refactoring, typos, etc.) | ||
REV: revert an earlier commit | ||
STY: style fix (whitespace, PEP8) | ||
TST: addition or modification of tests | ||
REL: related to releases | ||
``` | ||
## The Pull Request | ||
|
||
* Now push to your fork | ||
* Submit a [pull request](https://help.github.com/articles/using-pull-requests) to this branch. This is a start to the conversation. | ||
|
||
At this point you're waiting on us. We like to at least comment on pull requests within three business days | ||
(and, typically, one business day). We may suggest some changes or improvements or alternatives. | ||
|
||
Hints to make the integration of your changes easy (and happen faster): | ||
- Keep your pull requests small | ||
- Don't forget your unit tests | ||
- All algorithms need documentation, don't forget the .rst file | ||
- Don't take changes requests to change your code personally |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
<!--- Provide a general summary of the issue in the Title above --> | ||
|
||
## Expected Behavior | ||
<!--- If you're describing a bug, tell us what should happen --> | ||
<!--- If you're suggesting a change/improvement, tell us how it should work --> | ||
|
||
## Current Behavior | ||
<!--- If describing a bug, tell us what happens instead of the expected behavior --> | ||
<!--- If suggesting a change/improvement, explain the difference from current behavior --> | ||
|
||
## Possible Solution | ||
<!--- Not obligatory, but suggest a fix/reason for the bug, --> | ||
<!--- or ideas how to implement the addition or change --> | ||
|
||
## Steps to Reproduce (for bugs) | ||
<!--- Provide a link to a live example, or an unambiguous set of steps to --> | ||
<!--- reproduce this bug. Include code to reproduce, if relevant --> | ||
1. | ||
2. | ||
3. | ||
|
||
## Context | ||
<!--- How has this issue affected you? What are you trying to accomplish? --> | ||
<!--- Providing context helps us come up with a solution that is most useful in the real world --> | ||
|
||
## Your Environment | ||
<!--- Include as many relevant details about the environment you experienced the bug in --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
<!--- Provide a general summary of your changes in the Title above --> | ||
|
||
## Description | ||
<!--- Describe your changes in detail --> | ||
|
||
## Motivation and Context | ||
<!--- Why is this change required? What problem does it solve? --> | ||
<!--- If it fixes an open issue, please link to the issue here. --> | ||
|
||
## How Has This Been Tested? | ||
<!--- Please describe in detail how you tested your changes. --> | ||
<!--- Include details of your testing environment, and the tests you ran to --> | ||
<!--- see how your change affects other areas of the code, etc. --> | ||
|
||
<!-- | ||
## Screenshots (if appropriate): | ||
--> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
name: Check Code Style | ||
|
||
on: [push, pull_request] | ||
|
||
jobs: | ||
lint: | ||
runs-on: ubuntu-latest | ||
strategy: | ||
fail-fast: false | ||
steps: | ||
|
||
- uses: actions/checkout@v2 | ||
|
||
- uses: actions/setup-python@v2 | ||
|
||
- name: Install flake8 | ||
shell: bash -l {0} | ||
run: | | ||
set -vxeuo pipefail | ||
python -m pip install --upgrade pip | ||
python -m pip install flake8 | ||
python -m pip list | ||
- name: Run flake8 | ||
shell: bash -l {0} | ||
run: flake8 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
name: Unit Tests | ||
|
||
on: | ||
push: | ||
pull_request: | ||
schedule: | ||
- cron: '00 4 * * *' # daily at 4AM | ||
|
||
jobs: | ||
build: | ||
runs-on: ubuntu-latest | ||
services: | ||
mongodb: | ||
image: mongo | ||
ports: | ||
- 27017:27017 | ||
strategy: | ||
matrix: | ||
python-version: [3.6, 3.7, 3.8] | ||
fail-fast: false | ||
steps: | ||
|
||
- uses: actions/checkout@v2 | ||
|
||
- name: Set up Python ${{ matrix.python-version }} | ||
uses: actions/setup-python@v2 | ||
with: | ||
python-version: ${{ matrix.python-version }} | ||
|
||
- name: Install | ||
shell: bash -l {0} | ||
run: source continuous_integration/scripts/install.sh | ||
|
||
- name: Install test requirements | ||
shell: bash -l {0} | ||
run: | | ||
set -vxeuo pipefail | ||
python -m pip install -r requirements-test.txt | ||
python -m pip list | ||
- name: Test with pytest | ||
shell: bash -l {0} | ||
run: | | ||
set -vxeuo pipefail | ||
coverage run -m pytest -v | ||
coverage report |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
#!/bin/bash | ||
set -vxeuo pipefail | ||
|
||
# These packages are installed in the base environment but may be older | ||
# versions. Explicitly upgrade them because they often create | ||
# installation problems if out of date. | ||
python -m pip install --upgrade pip setuptools wheel numpy | ||
# Versioneer uses the most recent git tag to generate __version__, which appears | ||
# in the published documentation. | ||
git fetch --tags | ||
python -m pip install . | ||
python -m pip list |