📄️ how-to-contribute
TODO: Write doc
📄️ Source Control
We are pioneers in the use of Sapling-SCM, which is a Git-SCM compatible client developed by Meta. Sapling-SCM aims to bring the experience of their internal tool called SmartLog. This client is an old fork of Mercurial-SCM and has implemented/changed several features that make this tool truly unique. We recommend reading the launch notes about the system.
📄️ Repositories
Our code repositories are hosted on Github. Initially, we created our first repository under the Github user profile equetzal to take advantage of the Github Student Pack and Github Pro features during her university studies. Subsequently, we established the huronOS Github Organization to house all our new repositories. Eventually, we plan to migrate the first repository, huronOS-build-tools, to the organization. However, being a free organization, we do not have access to certain advanced features on Github. If we receive enough donations in the future, we may consider purchasing Github Enterprise or a similar solution. Alternatively, if we have our own infrastructure, we might explore the option of self-hosting with GitLab.
📄️ Documentation
Effective documentation plays a pivotal role in the success of software products. huronOS, designed for configuration by contest managers and utilization by contestants, places a strong emphasis on comprehensive documentation. Our website primarily serves as a repository for this essential information.
📄️ release-system
TODO: Write doc
📄️ Development Standards
huronOS development requires writing code in different environments which can lead to the use of different editors like nano, vi, or GUI powered editors like vscode. In any case, we are still inclined to maintain certain quality standards in our codebase to keep collaboration simpler.
📄️ Tips for Developing huronOS
So, if you plan on contributing constantly to this project, or you decide to fork it and continue on your own, these tips can help you iterate quicker on your development process. Let's check some of those tips:
📄️ Building huronOS
huronOS is an immutable system which is built in layers and modules to provide all the functionalities it is designed for. This means that to build the system you'll firstly need to:
📄️ building-manually
building-manually
📄️ Our current goals
TODO: Write doc