Skip to content

Latest commit

 

History

History
42 lines (24 loc) · 1.11 KB

CONTRIBUTING.md

File metadata and controls

42 lines (24 loc) · 1.11 KB

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 [email protected]: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.

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