Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #57 from jberlin/master
link to v3 FAQ docs
- Loading branch information
Showing
3 changed files
with
54 additions
and
4 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,42 @@ | ||
# Contributing | ||
|
||
We welcome pull requests with code improvements from anyone, as long as they are consistent with our design philosophy, and are code reviewed and tested. | ||
|
||
Please refer to our 'wishlist' issues for [needed code improvements][wishlist]. | ||
[wishlist]: https://github.com/wdas/SeExpr/issues?q=is%3Aissue+is%3Aopen+label%3Awishlist | ||
|
||
To work in the SeExpr code base: | ||
|
||
Fork, then clone the repo: | ||
|
||
git clone git@github.com:your-username/SeExpr. | ||
|
||
Set up your machine: | ||
|
||
cd SeExpr | ||
make install | ||
|
||
Make sure the tests pass: | ||
|
||
tbd | ||
|
||
Make your change. Add tests for your change. Make the tests pass: | ||
|
||
tbd | ||
|
||
Push to your fork and [submit a pull request][pr]. | ||
|
||
[pr]: https://github.com/wdas/SeExpr/compare/ | ||
|
||
We will strive to at least comment on pull requests within three business days. We may suggest some changes or improvements or alternatives. | ||
|
||
Some things that will increase the chance that your pull request is accepted: | ||
|
||
* Address issues tagged in our 'wishlist' | ||
* Write tests. | ||
* Comment code changes. | ||
* Write a good commit message. | ||
|
||
# Additional Resources | ||
|
||
* [Doxygen classes](http://wdas.github.io/SeExpr/doxygen/) |
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