Etiquette
Git Etiquette
Commits
Your commit messages are important. They summarize the changes made by your commit, and overall contribute a lot to the maintainability of the repository, and also comes in very handy when there’s a different changes happening at the same time.
All commits should follow the usual Conventional Commits standard.
Anything else?
There’s a lot of other things that can be standardized too, but aren’t really made use of right now. This section can be extended if and when the need arises.
Examples include Issues, PRs, projects, actions and whatever else you can do with git.
Software Licensing and Source Availability
It’s usually a good idea to open source code once it’s of some use. While there might be concerns with making what we do openly available, do remember that everything that we build is built on work that was freely made available to us. A lot of the work done is also inspired and recreated from code found on other club’s repositories.
Whenever you write some code that’s reused, plan to open source it as some point of time with the proper documentation, and a permissible license.
The TVMC, and related packages are all licensed under the MIT License, and the stonefish based simulator retains it’s GNU GPL v3 License from upstream.
If in doubt, pick one of the two licenses to use.
Open source good quality code.
You are expected to clean-up, document (here on bedrock and in the code), and open source all your contributions before you leave the club.