In order to keep our repository clean, pretty, and consistent, we ask that you make contributions in a particular way. The repository has a simple structure-- besides the main branch, each workshop has its own working branch, designated with a number and a one word descriptor for the workshop.
Use of main is reserved for major projects landmarks, such as the completion of work on a particular workshop. Workshop contributions should (almost) never be sent directly to main, but rather to the relevant project's branch.
We also ask that when making contributions, you fork the repository instead of attempting to commit directly to it. This goes a long way towards helping us achieve our goal of keeping this repo clean and organized.
When making a contribution, please follow this procedure:
- Fork the projects2021 repo and/or fetch changes from upstream to ensure that your fork is up to date.
- Make changes as necessary in the relevant workshop branch. For example, if contributing to the soldering workshop, switch to 1-soldering on your fork and make changes on that branch.
- Make a pull request to merge changes from your fork to the relevant branch on the main projects2021 repo.
If you want to get an idea of what this procedure might look like in action, you may refer to pull request psuieee/projects2021#6, which merged this write-up into main from a fork.