There are many ways that you can contribute to the AfterShip SDK project:
- Submit a bug
- Submit a code fix for a bug
- Submit additions or modifications to the documentation
- Submit a feature request
All code submissions will be reviewed and tested by the team, and those that meet a high bar for both quality and design/roadmap appropriateness will be merged into the source. Be sure to follow the existing structure when adding new files/folders.
All code should be error-free when run through golint and go vet. We recommend setting up your editor to:
- Run goimports on save
- Run golint and go vet to check for errors
You can find information in editor support for Go tools here: https://github.com/golang/go/wiki/IDEsAndTextEditorPlugins
If you encounter any bugs with the library please file an issue in the Issues section of the project.
Some guidance for when you make a contribution:
- Add/update unit tests and code as required by your change
- Make sure you run all the unit tests before you create a Pull Request.
- Run end-to-end tests or simple sample code to make sure the lib works in an end-to-end scenario.
If your contribution is significantly big it is better to first check with the project developers in order to make sure the change aligns with the long term plans. This can be done simply by submitting a question via the GitHub Issues section.
Want to get started hacking on the code? Super! Follow these instructions to get up and running.
First, make sure you have the prerequisites installed and available on your $PATH:
- Git
- Go 1.13 or higher
- Install pre-commit
Next, get the code:
- Fork this repo
- Clone your fork locally (
git clone https://github.com/<youruser>/aftership-sdk-go.git) - Open a terminal and move into your local copy (
cd aftership-sdk-go) - Run
pre-commit install
Run go build
Run make test