How to contribute

Elliot Ford edited this page May 12, 2015 · 3 revisions

Issue tracker

The JALSE project utilises https://github.com/Ellzord/JALSE/issues for bugs, questions, enhancements and ideas. To address any of these just create an issue (see How to open an issue). We make issues for anything and can close them just as fast (if they have been addressed) - so don't be afraid to make one.

Contributing without code

  • Finding and reporting bugs (see Have bugs or questions?)
  • Suggesting new direction or features
  • Helping others with their questions
  • Spreading the word!

Try and ensure similar tickets do not already exist before posting questions (you can comment on any issue).

Contributing with code

  • Fixing bugs
  • Creating unit tests
  • Creating new features
  • Creating example projects

JALSE uses the Fork and Pull request git model (see How to fork and Using pull requests). This is used with our build process to ensure we keep the code quality high (see Technologies we use).

Try to ensure all code work has an issue that can be used to track its progress (avoids duplicating work). For large code changes (excluding examples) please state your desire to do the change before implementing it - what's good and bad for the project is always up for discussion.

So make/update an issue, Fork Ellzord/JALSE, import into Eclipse (see Building from source), do your thing and send me a Pull Request!

Coding standards

The JALSE project standards only apply to Java code at this point in time and are not well defined (currently). They were originally based upon the Google Java Style.

For all those using Eclipse (recommended) please import the JALSE Java Formatter and code Clean-up. These can be ran against the source directory before commit.

All files should use Unix line delimiter.

Clone this wiki locally
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.