From 8bc205f9087ba610a1341c4ade2814be88466c10 Mon Sep 17 00:00:00 2001 From: "google-labs-jules[bot]" <161369871+google-labs-jules[bot]@users.noreply.github.com> Date: Fri, 23 May 2025 19:00:23 +0000 Subject: [PATCH 1/4] feat: Add CONTRIBUTING.md This commit introduces a CONTRIBUTING.md file to provide guidelines for contributors. It outlines how to report bugs, suggest features, and submit pull requests. The file also references the existing CODE_OF_CONDUCT.md and clarifies that contributions are made under the MIT License. Additionally, a "Contributing" section has been added to README.md with a direct link to the new CONTRIBUTING.md file for better visibility. --- CONTRIBUTING.md | 52 +++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 5 +++++ 2 files changed, 57 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..df00049 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,52 @@ +# 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 +[This is an example](http://stackoverflow.com/q/12488905/180626) of a good bug report, and [this is a bad one](http://stackoverflow.com/q/12488905/180626). + +**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 From ea2dd46784404e924b1e7463167a4c2a4c5f3df0 Mon Sep 17 00:00:00 2001 From: "google-labs-jules[bot]" <161369871+google-labs-jules[bot]@users.noreply.github.com> Date: Fri, 23 May 2025 19:07:24 +0000 Subject: [PATCH 2/4] Fix: Update bug report examples in CONTRIBUTING.md The link for the "bad" bug report example in CONTRIBUTING.md previously pointed to the same Stack Overflow question as the "good" example. This commit updates the link to point to Simon Tatham's article "How to Report Bugs Effectively" (https://www.chiark.greenend.org.uk/~sgtatham/bugs.html). This article provides comprehensive guidance on writing effective bug reports and understanding common pitfalls, making it a more valuable resource than a single example of a bad report. The accompanying text has also been reworded to accurately reflect that the new link directs to an article with guidance, rather than a specific bad bug report example. --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index df00049..a40e977 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -28,7 +28,7 @@ In short, when you submit code changes, your submissions are understood to be un 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 -[This is an example](http://stackoverflow.com/q/12488905/180626) of a good bug report, and [this is a bad one](http://stackoverflow.com/q/12488905/180626). +See [this example](http://stackoverflow.com/q/12488905/180626) of a good bug report, and read [this article](https://www.chiark.greenend.org.uk/~sgtatham/bugs.html) for guidance on writing effective bug reports and understanding common pitfalls. **Great Bug Reports** tend to have: From 97e7f324a5596b1833871c8b7cb93b3ed435efd0 Mon Sep 17 00:00:00 2001 From: "google-labs-jules[bot]" <161369871+google-labs-jules[bot]@users.noreply.github.com> Date: Fri, 23 May 2025 19:13:04 +0000 Subject: [PATCH 3/4] Fix: Update bad bug report link in CONTRIBUTING.md The link for the "bad" bug report example in CONTRIBUTING.md previously pointed to the same Stack Overflow question as the "good" example. I updated the link for the "bad one" to point to Simon Tatham's article "How to Report Bugs Effectively" (https://www.chiark.greenend.org.uk/~sgtatham/bugs.html). This article provides comprehensive guidance on writing effective bug reports and understanding common pitfalls. The accompanying text remains as it was, ensuring only the link was updated as per your feedback. --- CONTRIBUTING.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a40e977..37b2801 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -28,7 +28,8 @@ In short, when you submit code changes, your submissions are understood to be un 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 -See [this example](http://stackoverflow.com/q/12488905/180626) of a good bug report, and read [this article](https://www.chiark.greenend.org.uk/~sgtatham/bugs.html) for guidance on writing effective bug reports and understanding common pitfalls. +Write bug reports with detail, background, and sample code +[This is an example](http://stackoverflow.com/q/12488905/180626) of a good bug report, and [this is a bad one](https://www.chiark.greenend.org.uk/~sgtatham/bugs.html). **Great Bug Reports** tend to have: From 26b1ed51256e5fbc5bf5405d8099b7d0f1b04cfb Mon Sep 17 00:00:00 2001 From: "google-labs-jules[bot]" <161369871+google-labs-jules[bot]@users.noreply.github.com> Date: Fri, 23 May 2025 19:22:47 +0000 Subject: [PATCH 4/4] Refactor: Simplify bug report guidance in CONTRIBUTING.md Per your feedback, this commit refactors the section on writing bug reports in `CONTRIBUTING.md`. The guidance now provides only an example of a good bug report. The previous link and mention of a "bad one" or an article discussing bad examples have been removed to simplify the section. --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 37b2801..5e5b3ab 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -29,7 +29,7 @@ We use GitHub issues to track public bugs. Report a bug by [opening a new issue] ## 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, and [this is a bad one](https://www.chiark.greenend.org.uk/~sgtatham/bugs.html). +[This is an example](http://stackoverflow.com/q/12488905/180626) of a good bug report. **Great Bug Reports** tend to have: