Github repository: https://github.com/JCSDA/spack-stack
Documentation: https://spack-stack.readthedocs.io/en/latest/
Table of Contents |
---|
spack-stack Development
If you are going to contribute to the spack-stack repository, development is done by forking the spack-stack repository. This section contains steps to fork spack-stack from https://github.com/JCSDA/spack-stack, make changes, and issue a PR.
- Create a fork of https://github.com/JCSDA/spack-stack by clicking the "Fork" button on the top right side of the page to "Fork your own copy of JCSDA/spack-stack".
- Navigate to your repositories and click on the spack-stack repo. Clicking the green "Code" button will show you options to clone this repository. One option is by using https and running
git clone https://github.com/<your_username>/spack-stack.git
- Rename your fork to your name in order to help keep track of multiple user and the authoritative forks. Therefore after you clone the repository run
git remote rename origin <your_name>
. This can be verified by runninggit remote -v
- You can now create a branch and start developing. Note, make sure you pull the authoritative develop brand if your fork is out of date.
- Once your branch is ready for review, you will need to create a PR inside https://github.com/JCSDA/spack-stack pointing to your fork and branch. Push your PR to your fork by running
git push <your_name> feature/<your_branch>
. Then open the PR request form in a bowser adding the necessary information and setting the base repository to JCSDA/spack-stack.
For further reading on using github forks, checkout this site and this one too.