-
Notifications
You must be signed in to change notification settings - Fork 5
Contribution Guidelines
OccupOS was designed with extensibility in mind. It should be relatively easy to get started customising the project to your needs. Pull-requests are welcomed (we promise to go over each one personally), that said we do have a few rules.
- Ensure your patch matches our documented code style.
- Try to keep patches small and focused (e.g. support for a single new sensor or a single bug fix).
- Patches with unnecessary formatting changes will be rejected (e.g. the addition of trailing whitespace and/or newlines).
We do not encourage major refactors unless they are focused on performance or reliability. The majority of the existing codebase has been fully tested in multiple environments and though we like professional looking code, we cannot justify risking the introduction of bugs for cosmetic reasons only. Having said that, small sections of readability refactoring will be reviewed and merged in if deemed acceptable.
Patches implementing features from our backlog are highly encouraged, though we advise that you stay in contact throughout the process so that we may provide feedback on the direction of your implementation. Using the comments feature on the relevant GitHub issue is the ideal way to go about this. Features can be suggested by creating a new issue and marking it with the ‘type:feature suggestion’ label.
Please see our code style guidelines.