Skip to content

Commit 57c3387

Browse files
authored
Create Contributing.md
1 parent a84b831 commit 57c3387

1 file changed

Lines changed: 29 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
## Contributing
2+
3+
Contributions to ScaffoldGraph will most likely fall into the following categories:
4+
5+
1. Implementing a new Feature:
6+
* New Features that fit into the scope of this package will be accepted. If you are unsure about the
7+
idea/design/implementation, feel free to post an issue.
8+
2. Fixing a Bug:
9+
* Bug fixes are welcomed, please send a Pull Request each time a bug is encountered. When sending a Pull
10+
Request please provide a clear description of the encountered bug. If unsure feel free to post an issue
11+
12+
Please send Pull Requests to:
13+
http://github.com/UCLCheminformatics/scaffoldgraph
14+
15+
### Testing
16+
17+
ScaffoldGraphs testing is located under `test/`. Run all tests using:
18+
19+
```
20+
$ python setup.py test
21+
```
22+
23+
or run an individual test: `pytest --no-cov tests/core`
24+
25+
When contributing new features please include appropriate test files
26+
27+
### Continuous Integration
28+
29+
ScaffoldGraph uses Travis CI for continuous integration

0 commit comments

Comments
 (0)