Mirrors/go-inbucket
1
0
Fork 0
mirror of https://github.com/jhillyerd/inbucket.git synced 2025-12-17 17:47:03 +00:00
Code Issues Releases Wiki Activity
Files
40ec108dafc0e189cdd914b7dc8f09ba7f9d2a6c
go-inbucket/CONTRIBUTING.md
James Hillyerd 357589d90e Rename master branch to main (#255) 
* Update contributing guide, remove git-flow references

Signed-off-by: James Hillyerd <james@hillyerd.com>

* Update changelog for main branch rename

Signed-off-by: James Hillyerd <james@hillyerd.com>

* Update github actions for branch rename

* Update README build badges

Signed-off-by: James Hillyerd <james@hillyerd.com>

* Update README for new branch names

Signed-off-by: James Hillyerd <james@hillyerd.com>

* Note branch rename in change log

Signed-off-by: James Hillyerd <james@hillyerd.com>
2022-01-17 17:16:44 -08:00

936 B
Raw Blame History

How to Contribute

Inbucket encourages third-party patches. It's valuable to know how other developers are using the product.

Getting Started

If you anticipate your issue requiring a large patch, please first submit a GitHub issue describing the problem or feature. You are also encouraged to outline the process you would like to use to resolve the issue. I will attempt to provide validation and/or guidance on your suggested approach.

Making Changes

Inbucket follows the regular GitHub pattern. Create a topic branch from where you want to base your work:

Once you are on your topic branch:

  1. Make commits of logical units.
  2. Add unit tests to exercise your changes.
  3. Run make to test, vet and confirm your code is formatted correctly. If you do not have Make installed, please perform these steps manually, otherwise your PR will not pass our checks.

Thanks

Thank you for contributing to Inbucket!