CONTRIBUTING.md

Contributing

Git Workflow

Step 1: Fork the repository

Step 2: Git Setup & Download

# Clone the repo
$ git clone https://github.com/<User-Name>/project-vormir.git

# Add upstream remote
$ git remote add upstream https://github.com/coep-astronomy/project-vormir.git

# Fetch and rebase with upstream/development
$ git fetch upstream
$ git rebase upstream/development

# Push if any changes are rebased
$ git push origin development

Step 3: Create and Publish Working Branch

# Ensure you are in the development branch
$ git checkout development

# Create your new branch
$ git checkout -b <type>/<issue|issue-number>/{<additional-fixes>}
$ git push origin <type>/<issue|issue-number>/{<additional-fixes>}

## Types:
# wip - Work in Progress; long term work; mainstream changes;
# feat - New Feature; future planned; non-mainstream changes;
# bug - Bug Fixes;
# refactor - Code Refactors;
# junk - Experimental; random experiemntal features; throwaway branch;

While making changes, Step 4: Commit your work

# Ensure branch
$ git branch

# Fetch and rebase with upstream/development
$ git fetch upstream
$ git rebase upstream/development

# Add untracked files one by one
$ git add filename

# Commit all changes with appropriate commit message and description. Strcitly follow commit message standards.
$ git commit -m "your-commit-message" -m "your-commit-description"

After completion, Step 5: Fetch, rebase and push your work

# Ensure branch
$ git branch

# Fetch and rebase with upstream/development
$ git fetch upstream
$ git rebase upstream/development

# Push changes to your forked repository
$ git push origin <type>/<issue|issue-number>/{<additional-fixes>}

# If rebase adds commits in your older commit history, use force push
$ git push --force origin <type>/<issue|issue-number>/{<additional-fixes>}

## Creating the PR using GitHub Website

Step 6: Create the PR using GitHub Website

1. Create Pull Request from /<issue|issue-number>/{} branch in your forked repository to the development branch in the upstream repository. Again, ensure the name follows commit standards and the description must detail the work done. Ensure you tag the appriparite issue in the PR Message.
2. After creating PR, add a Reviewer (Any Admin) and add yourself as the assignee
3. Do Not Merge the PR. That will be done by the reviewer.

After PR Merge, Step 7: Working repository cleanup

# Delete branch from forked repo
$ git branch -d <type>/<issue|issue-number>/{<additional-fixes>}
$ git push --delete origin <type>/<issue|issue-number>/{<additional-fixes>}

# Fetch and rebase with upstream/development
$ git checkout development
$ git rebase upstream/development
$ git push --force origin development

---

Important Instuctions & Guides

• Always follow commit message standards
• About the fork-and-branch workflow