Skip to content

Latest commit

 

History

History
41 lines (29 loc) · 1.63 KB

CONTRIBUTING.md

File metadata and controls

41 lines (29 loc) · 1.63 KB

Contributing to Feersum

Feersum is open source software. Contributions are welcome. Please follow a few simple guidelines to make your contribution extra awesome:

  • Small contributions can be submitted as pull requests.
  • Open an issue and discuss larger changes before cutting code.

For information on the structure of the compiler, and how to build and test Feersum yourself check out the DEVGUIDE

Keep it Small or Discuss First

Seen as I'm sharing the development of this compiler I'd like to reserve the option to tackle larger issues on stream. If you'd like to make a significant refactoring to the codebase, or contribute a significant new feature please open an issue first so we can discuss. If it isn't on the roadmap on the main README or part of a Roadmap issue chances are it will be welcome.

Quick Fixes

I am notoriously bad at:

  • typing
  • reading what I have typed.

If you find something super simple that's been nagging you then please open a PR to fix it.

Up for Grabs

Some issues are marked up for grabs. These issues are not currently claimed and are free to be worked on. If you'd like to tackle one then shout out in the comments on the issue and I'd be happy to assign it to yo.