Skip to content

A bit opinionated Rust project template

Notifications You must be signed in to change notification settings

GuiBL4/rust-repository-template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Rust project repository template

This repository template provides a pre-configured (and probably opiniated) Rust project template that enforces the Rust coding's best practices and guidelines the Sofair ecosystem would like to enforce in its project repositories. Of course, if you want to modify or refine some of the tools or configurations that are offered, you can do so.

How to use this project template

In order to use this Rust project template, here are the steps to follow:

  • Create your repo: start by creating a new repository from this template for your project, giving the latter a new name.

  • Set your project's title: replace the title of this REAMDE.md file, with the name of your new project.

  • Set your Git username and email: so that to put a name on a contribution and be able to contact the author, please set your Git username and email.

  • ... more to come

How can I contribute to this project

Open source software is neither contagious nor a cancer, as some narrow-minded people have said in the past!

We therefore encourage you to jump on the free software bandwagon and help us, through your contributions and your passion (which we hope will be as contagious as possible), to build this audacious project with our community.

"How can I contribute to this project", you may ask? First, we invite you to read carefully our Contributor's Bible.

The second question you are probably asking yourself is "how can I be of help to this project"? Here are a few suggestions that come to mind:

  • Sharing knowledge and know-how is crucial in such community-driven project. So why not helping us writing the documentation? This will give you a good understanding of the concepts and technology behind Sofair.

  • If you're a passionate software engineer, why not contributing through coding? Some challenging tasks in cryptography, graph-based database, blockchain, networking, maths and more can challenge your neurons. Be sure that the core projec's team will always take care of onboarding newcommers with care, so that they feel comfortable contributing with us.

  • And more...

The next concrete step is to take the plunge by picking one the outstanding tasks on the project's management board. For doing so, please bump to the Getting started paragraph of our Contributor's Bible.

If none of the above resonates with you, do not hesitate to send us an email at [email protected]. You are sure to meet an open tribe eager to accept new ideas or contributions. Don't be shy!

Licenses and copyright

All contributions to this project are licensed under either of the following licenses:

About

A bit opinionated Rust project template

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages