CONTRIBUTING.md 1019 Bytes
Newer Older
Ryan Hunt's avatar
Ryan Hunt committed
1 2 3 4
# Contributing

Thanks for wanting to contribute!

Ryan Hunt's avatar
Ryan Hunt committed
5
If you want help or mentorship, please file a Github issue and I'll be sure to provide guidance to the best of my ability.
Ryan Hunt's avatar
Ryan Hunt committed
6 7 8 9 10

Otherwise be sure to check out `ARCHITECTURE.md` for an overview on the internals.

## Filing a pull request

Ryan Hunt's avatar
Ryan Hunt committed
11
Check out [Servo's Github workflow](https://github.com/servo/servo/wiki/Github-workflow) for an overview on creating a pull request.
Ryan Hunt's avatar
Ryan Hunt committed
12

Ryan Hunt's avatar
Ryan Hunt committed
13
Don't worry about requesting code review, as there is nothing formally setup for this repository. I try and review each pull request as soon as I can.
Ryan Hunt's avatar
Ryan Hunt committed
14

Ryan Hunt's avatar
Ryan Hunt committed
15
There is continuous integration setup for `cbindgen` using [travis](https://travis-ci.org/). It automatically runs `./test.py` which runs `cbindgen` against a series of rust files from `tests/rust/` and checks that the output compiles using `gcc` or `g++`.
Ryan Hunt's avatar
Ryan Hunt committed
16

Ryan Hunt's avatar
Ryan Hunt committed
17 18 19
Please run `./test.py` before filing a pull request to be sure that all tests pass. This will also update the test expectations.

Bonus points if you write a new test for your pull request!