Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
73 lines (45 loc) · 1.91 KB

CONTRIBUTING.md

File metadata and controls

73 lines (45 loc) · 1.91 KB

Contributing

Welcome to argc-completions and thank you for considering contributing!

Tool docs

Set up your own fork of the argc-completions repository

  1. Fork the sigoden/argc-completions repository on GitHub.

This creates a personal remote repository that you can push to. This is needed because only argc-completions maintainers have push access to the main repositories.

  1. Change to the ARGC_COMPLETIONS_ROOT
cd $ARGC_COMPLETIONS_ROOT
  1. Add your pushable forked repository as a new remote:
git remote add <YOUR_USERNAME> https://github.com/<YOUR_USERNAME>/argc-completions.git

Create your pull request from a new branch

To make changes on a new branch and submit it for review, create a GitHub pull request with the following steps:

  1. Check out the main branch:
git checkout main
  1. Retrieve new changes to the master branch:
git pull origin main
./scripts/download-tools.sh

  1. Make your changes.

  2. Check your completion script

argc check <COMMAND>
  1. Commit the changes

Our prefered commit message format:

  • add: COMMAND if your add a new completion script. e.g. add: cargo-binstall

  • COMMAND: ... if your modify a completion script.

  1. Upload your branch of new commits to your fork:
git push --set-upstream <YOUR_USERNAME> <YOUR_BRANCH_NAME>

  1. Go to the https://github.com/sigoden/argc-completions and create a pull request to request review and merging of the commits from your pushed branch.

  2. Await feedback or a merge from Homebrew’s maintainers.