Skip to content

Contributing to the Project

Mark Fisher edited this page Aug 21, 2024 · 5 revisions

The fujinet project has grown and accepted changes from nearly 60 contributors over its inception in 2019.

We will continue to welcome all changes to the repository, no matter how small or large.

However, with we do ask that contributors follow a simple set of rules before making their contributions

  1. Fork the repository
  2. Ensure your changes are merged and tested with the latest changes in your fork
  3. Create a PR to the main repository

This ensures that all contributions are following the same process, and have been locally tested.

It also gives the main repository a clean history, that is simple to debug or diff when we are making releases and concentrating on testing all platforms.

It also means the github actions run on your fork before they are run in the main repository to ensure all platforms are compiling, and gives the contributor early warning of any breakages they may not have anticipated in their change on other target platforms.

More information on the development guidelines.

There is also a script to help make this process as painless and simple as possible in case you aren't a git guru.

Thank you for your continued contributions!

Clone this wiki locally