Contribution guide

Branching

1. To create a branch, you will first need to clone the repository to a directory on your machine. Open a terminal in the directory you wish to place the repository files and then type git clone <https link to repo>
   Example: git commit https://github.com/dany-cpp/QuantumPermutationPad.git
2. After you have cloned the repository, change your terminal directory to the repository you just cloned and type git checkout -b <name of your branch>
   Example: git checkout -b MyName-new-branch
   The checkout command switches your working branch, and the -b flag creates a new branch.
3. Branch, name, if linked to an issue, must contains the issue number in this format. For example "MP-10" for PR linked to issue #10.
4. You can check all of the local branches on your machines using git branch
   If another member has created new remote branches that are not yet on your machine, you can access those branches using
   git fetch

Pull request

1. First, stage your changes by using git add <changed_file>
   Example: git add /C++/my_code.cpp
   Do not use git add . because it will stage unnecessary files. A goode IDE can help you with this.
2. Commit by using git commit -m "My message". Give it a meaningful one such as "Fixed bug for input" instead of "Minor fix"
3. Rebasing from main meaning you update your code. This is due to because during you work on your branch, other people have made updates. To do this, use git rebase -i origin/main. After that, type :wq and Enter. This is Vim syntax, ask me for more details about this step.
4. Push your changes via git push.
5. On the project page [Here](https://github.com/danny-cpp/QuantumPermutationPad). Click on Pull Request tab. Click on New Pull Request button, and create one from your branch to main.
6. Ping on Discord to get it reviewed.

---

Compile and execute guide

For C++ code

1. In the C++ directory, you will find the Makefile. In line 38, change it to MODE := $(RELEASE) or MODE := $(DEBUG) as you wish. Currently, we only support these 2 modes. Note that to use GDB to debug, you must use Debug profile.
2. In the same directory use make the compile the code; make clean to clean everything.
3. If the process run successfully, you will find a new binary in bin/. To execute, run ./bin/qpp.exe.