diff --git a/docs/contributing.md b/docs/contributing.md new file mode 100644 index 0000000..daaffc7 --- /dev/null +++ b/docs/contributing.md @@ -0,0 +1,30 @@ +--- +Title: Contribution Guide +Prev: +Next: +--- + +# YREA SLS Contribution Guide + +**Contributions will not be accepted before Monday, December 15, 2025** + +You can begin by cloning the public repo: +``` +git clone https://git.purplecello.org/KylerOlsen/YREA-SLS.git +``` + +Create a new branch to work in: +``` +git checkout -b my-feature +``` + +Make your changes. Please make small changes per commit. Please make sure to include `-s` on your commits. + +Create a patch. This just creates one for the latest commit, the internet or AI can help you make a patch for multiple commits. +``` +git format-patch -1 +``` + +This will create a file like: `0001-fix-something.patch`. You will email the contents of this file to Kyler Olsen ([Contact Info](https://purplecello.org/contact.html)). + +The subject should be something like `[PATCH] Fix Something`. diff --git a/docs/index.md b/docs/index.md index a3080bd..c54f5f2 100644 --- a/docs/index.md +++ b/docs/index.md @@ -33,6 +33,7 @@ Next: Overview --- **Other**: +- [Contribution Guide](./contributing.html) - [Missing Features](./missing_features.html) - [SE 3250 Assignment Details](./se_3250_assignment_details.html) - [Changed](./changes.html)