From a37577095b07ae3eedd50f5cb3a26b343a6c5f61 Mon Sep 17 00:00:00 2001 From: Charlotte Aten Date: Mon, 21 Jul 2025 09:04:13 -0600 Subject: [PATCH] Added Git workflow --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 80705de..6eb50bd 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,19 @@ discrete neural net and polymorphic learning in Python. For more information on these notions, see [the corresponding preprint](https://arxiv.org/abs/2308.00677) on the arXiv. +### Git workflow +1) Fork main repo (http://git.aten.cool/caten/DiscreteNeuralNets). This is + different than just cloning. There is a button on Forgejo for this. +2) Clone your fork to your machine. +3) Make a branch on your machine. +4) At any time, you can push your changes to your personal fork of the repo. +5) On your machine, pull from the main repo's main branch. +6) On your machine, merge the main branch into your new branch. +7) Resolve any conflicts that arise, then merge your new branch into the main + branch. +8) Push your work to your personal fork of the repo. +9) Make a pull request to pull your fork's main into the original repo's main. + ### Project structure The scripts that define basic components of the system are in the `src` folder. These are: