Skip to content

Latest commit

 

History

History
71 lines (63 loc) · 2.83 KB

CONTRIBUTING.md

File metadata and controls

71 lines (63 loc) · 2.83 KB
Raw

Contributing to mxochicale/tools.

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

When contributing to this repository, please first discuss the change you wish to make via issue, instant message in clara-agx chatbox, or any other method with the owners of this repository before making a change. Please note we have a code of conduct, please follow it in all your interactions with the project.

:octocat: Setting up project locally.

  1. Generate your SSH keys as suggested here
  2. Clone the repository by typing (or copying) the following lines in a terminal
git clone [email protected]:mxochicale/tools.git

New issues

  flowchart TD;
      Z[Bug Reported] -->A[...];  
      A[Bug resolution] -->B(Testing OK?);
      B--Yes-->C[Prepare commit];
      B--No-->D[Reopen issue];
      D----> A[Bug resolution];
      C ----> E[Request Review];
      E ----> F[Commit changes];
      F --> H[Merge PR and close issue]
Loading

Committing and pushing changes

  1. Clone this repo
git clone [email protected]:mxochicale/tools.git
  1. Create new branch using issue number
git checkout -b ISSUENUMBER-branch-name
  1. Commit changes and push to your branch
git add .
git commit -m 'short message (#ISSUENUMBER)'
git push origin ISSUENUMBER-branch-name
  1. Submit a Pull Request against the main branch.

Pull Request (PR) and merge to main branch

  1. Select branch that contain your commits.
  2. Click Compare and pull request and create PR for the associated branch.
  3. Type a title and description of your PR and create PR
  4. Please keep your PR in sync with the base branch.
git checkout main
git pull origin main
git checkout RB 
git rebase main
git push --force origin RB
  1. Run pre-commit to tidy up code and documentation (see next section).
  2. Request a PR review. See collaborating-with-pull-requests for further details.
  3. Once your PRs has been approved, procced to merge it to main. See Merging a pull request
  4. Remove your merged branch from your repo and in the list of https://github.com/mxochicale/tools/branches
#Local git clear
git branch --merged | grep -v '\*\|master\|main\|develop' | xargs -n 1 git branch -d
#Remote git clear
git branch -r --merged | grep -v '\*\|master\|main\|develop' | sed 's/origin\///' | xargs -n 1 git push --delete origin