github.com/awslabs/fargatecli@v0.3.2-0.20210502061925-aa1c09cd404e/CONTRIBUTING.md (about) 1 **Welcome!** Thank you for considering contributing to this project! If I can 2 help in anyway to get you going, please feel free to reach out. I'm available by 3 email and Google Hangouts at john@pignata.com. 4 5 # Contributing 6 7 ## Workflow 8 9 - **Did you find a bug?** 10 11 Awesome! Please feel free to open an issue first, or if you have a fix open a 12 pull request that describes the bug with code that demonstrates the bug in a 13 test and addresses it. 14 15 - **Do you want to add a feature?** 16 17 Features begin life as a proposal. Please open a pull request with a proposal 18 that explains the feature, its use case, considerations, and design. This will 19 allow interested contributors to weigh in, refine the idea, and ensure there's 20 no wasted time in the event a feature doesn't fit with our direction. 21 22 ## Setup 23 24 - Ensure you're using golang 1.9+. 25 26 ```console 27 go version 28 ``` 29 30 - Install [`dep`][dep] if not present on your system. See their [installation 31 instructions][dep-install] and [releases page][dep-releases] for details. 32 33 - Install the source code from GitHub 34 35 ```console 36 go get github.com/awslabs/fargatecli 37 ``` 38 39 - Run `dep ensure` to install required dependencies 40 41 ```console 42 cd $GOPATH/src/github.com/awslabs/fargatecli 43 dep ensure 44 ``` 45 46 - Make sure you can run the tests 47 48 ```console 49 make test 50 ``` 51 52 ## Testing 53 54 - Tests can be run via `go test` or `make test` 55 56 - To generate mocks as you add functionality, run `make mocks` or use `go 57 generate` directly 58 59 ## Building 60 61 - To build a binary for your platform run `make` 62 63 - For cross-building for all supported platforms, run `make dist` which builds 64 binaries for darwin (64-bit) and linux (Arm, 32-bit, 64-bit). 65 66 ## Licensing 67 68 This project is released under the [Apache 2.0 license][apache]. 69 70 ## Code of Conduct 71 72 This project abides by the [Amazon Open Source Code of Conduct][amzn-coc]. 73 Please be nice. 74 75 [dep]: https://golang.github.io/dep 76 [dep-install]: https://golang.github.io/dep/docs/installation.html 77 [dep-releases]: https://github.com/golang/dep/releases 78 [amzn-coc]: https://aws.github.io/code-of-conduct 79 [apache]: http://aws.amazon.com/apache-2-0/