Skip to content

Contributing

How to contribute to FlatTrack.

Code

For a dive into getting started in development, please read the development docs. A good place to start is the GitLab issues, filtering by issues which are good for new contributors.

Testing

Tests are written for the backend and frontend, please read the testing docs.

Community

Engagement

Let others in the larger FOSS community know about FlatTrack.

Outside of the FOSS community:

  • finding the needs of those living in flats
  • get others to try it and find their thoughts on the project

Guidelines

You may wish to contribute to the community guidelines.

Artwork & Design

Although not essential, it is a good idea to have an idea for frontend web development technologies.

Documentation

Wanna help improve the documentation of FlatTrack? For code related documentation the cycle is similar to the development docs.

For these docs:

  • go through the docs and see if all of the bases are covered (e.g: deployment, development, etc…), then include what is not documented
  • consider new areas which could be documented
  • improve the quality of existing documentation