diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..5e5b3ab --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,53 @@ +# Contributing to k8f + +We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's: + +- Reporting a bug +- Discussing the current state of the code +- Submitting a fix +- Proposing new features +- Becoming a maintainer + +## We Develop with Github +We use GitHub to host code, to track issues and feature requests, as well as accept pull requests. + +## We Use [Github Flow](https://guides.github.com/introduction/flow/index.html), So All Code Changes Happen Through Pull Requests +Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests: + +1. Fork the repo and create your branch from `main`. +2. If you've added code that should be tested, add tests. +3. If you've changed APIs, update the documentation. +4. Ensure the test suite passes. +5. Make sure your code lints. +6. Issue that pull request! + +## Any contributions you make will be under the MIT Software License +In short, when you submit code changes, your submissions are understood to be under the same [MIT License](LICENSE) that covers the project. Feel free to contact the maintainers if that's a concern. + +## Report bugs using Github's [issues](https://github.com/AdamRussak/k8f/issues) +We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/AdamRussak/k8f/issues/new); it's that easy! + +## Write bug reports with detail, background, and sample code +Write bug reports with detail, background, and sample code +[This is an example](http://stackoverflow.com/q/12488905/180626) of a good bug report. + +**Great Bug Reports** tend to have: + +- A quick summary and/or background +- Steps to reproduce + - Be specific! + - Give sample code if you can. +- What you expected would happen +- What actually happens +- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work) + +People *love* thorough bug reports. I'm not even kidding. + +## Use a Consistent Coding Style +* You can try running `golangci-lint run` for style unification + +## License +By contributing, you agree that your contributions will be licensed under its MIT License. + +## Code of Conduct +This project and everyone participating in it is governed by the [k8f Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [adam.russak@gmail.com](mailto:adam.russak@gmail.com). diff --git a/README.md b/README.md index 25c09b5..0b6b580 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,7 @@ you can get you're EKS/AKS output with **k8s name**, **account**, **region**, ** - [list](#list) - [connect](#connect) - [find](#find) + - [Contributing](#contributing) - [How to install](#how-to-install) - [Windows](#windows) - [Linux](#linux) @@ -149,6 +150,10 @@ Global Flags: -v, --verbose verbose logging ``` +## Contributing + +We welcome contributions! Please see our [CONTRIBUTING.md](CONTRIBUTING.md) for details on how to get started, report bugs, and submit pull requests. + ## How to install ### Windows