Skip to content

Latest commit

 

History

History
48 lines (36 loc) · 1.65 KB

CONTRIBUTING.md

File metadata and controls

48 lines (36 loc) · 1.65 KB

Contributing to Flight

Flight is already pretty awesome, here is your guide to making it better!

If you have questions, you can talk to Sam ([email protected]).

Finding an Issue

All issues are carefully labeled according to the following system:

  • A - *: Area of the codebase
  • P - *: Priority/schedule
  • Enhancement: API/implementation improvement
  • Bug: Implementation mistake
  • Refactor: Move/rename API items
  • Rework: Redesign of a subsystem
  • Spike: Research/prototyping
  • Good First Issue: A problem that can be tackled with little flight/Rust experience.

Good first issue search

Checklist

  • Document functions/modules/traits/structs/enums/etc. A PR without documentation will not be accepted.
  • Run scripts/travis-script.sh. Is it happy?
  • Write some tests. It isn't required, but you still should.
  • Submit a PR!

Scripts and Building

We use Travis CI to make sure things don't explode. To check for the same explosions locally, run scripts/travis-script.sh. You can build and view the docs with cargo doc --open. To try an example, cd into the relevant directory (e.g. examples/intro) and cargo run --release.

Helpful Links and Information

There will be stuff here someday.