Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
59 lines (40 loc) · 999 Bytes

CONTRIBUTING.md

File metadata and controls

59 lines (40 loc) · 999 Bytes
Raw

Contributing

Contributions are welcome. The usual workflow is fork, branch, commit, and open a pull request.

Workflow

  1. Fork the repository on GitHub.
  2. Clone your fork:
git clone https://github.com/YOUR-USER/bgit.git
cd bgit
  1. Add the upstream repository:
git remote add upstream https://github.com/bucketgit/bgit.git
  1. Create a feature branch:
git checkout -b feature/my-change
  1. Make your changes and add tests where behavior changes.
  2. Run the checks:
go test ./...
go build ./...
  1. Commit your changes:
git add .
git commit -m "Describe the change"
  1. Push your branch:
git push origin feature/my-change
  1. Open a pull request against bucketgit/bgit.

Pull Requests

Please keep pull requests focused. Include:

  • A short description of the change.
  • Any relevant usage examples.
  • Notes about tests you ran.

For user-facing changes, update README.md or CHANGELOG.md when appropriate.