Skip to content

Contributing to the Project

europlus edited this page Sep 3, 2024 · 5 revisions

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

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

With the growth in contributors, and parallel changes coming into different platforms, we are laying out a simple set of rules before contributions will be accepted:

  1. Fork the repository
  2. Ensure your changes are merged and tested with the latest changes in your fork (rebasing to a single commit is preferred, see below)
  3. Create a PR to the main repository

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

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 for official releases.

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 can be found at the development guidelines, particularly about rebasing changes to a single commit.

There is also a script to help make the 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