mirror of
https://github.com/aws-actions/configure-aws-credentials.git
synced 2026-08-23 04:15:08 +09:00
Tom Keller
124 lines
5.0 KiB
Markdown
124 lines
5.0 KiB
Markdown
# Contributing Guidelines
|
|
|
|
Thank you for your interest in contributing to our project. Whether it's a bug
|
|
report, new feature, correction, or additional documentation, we greatly value
|
|
feedback and contributions from our community.
|
|
|
|
Please read through this document before submitting any issues or pull requests
|
|
to ensure we have all the necessary information to effectively respond to your
|
|
bug report or contribution.
|
|
|
|
## Reporting Bugs/Feature Requests
|
|
|
|
We welcome you to use the GitHub issue tracker to report bugs or suggest
|
|
features.
|
|
|
|
When filing an issue, please check [existing open][open-issues],
|
|
or [recently closed][closed-issues], issues to make sure somebody
|
|
else hasn't already reported the issue.
|
|
|
|
[open-issues]: https://github.com/aws-actions/configure-aws-credentials/issues
|
|
[closed-issues]: https://github.com/aws-actions/configure-aws-credentials/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20
|
|
|
|
Please try to include as much information as you can. Details like
|
|
these are incredibly useful:
|
|
|
|
- A reproducible test case or series of steps
|
|
- The version of our code being used
|
|
- Any modifications you've made relevant to the bug
|
|
- Anything unusual about your environment or deployment
|
|
|
|
We also ask that you refrain from opening issues via the `gh` CLI or GitHub
|
|
API. These methods bypass our issue templates and therefore don't apply the
|
|
proper labels or workflows that we use. Note that AI agents typically do not
|
|
properly use issue templates. Issues that don't have the proper labels
|
|
applied may be closed without comment.
|
|
|
|
## Contributing via Pull Requests
|
|
|
|
Contributions via pull requests are much appreciated. Before sending us a pull
|
|
request, please ensure that:
|
|
|
|
1. You are working against the latest source on the _main_ branch.
|
|
2. You check existing open, and recently merged, pull requests to make sure
|
|
someone else hasn't addressed the problem already.
|
|
3. You open an issue to discuss any significant work - we would hate for your
|
|
time to be wasted.
|
|
|
|
To send us a pull request, please:
|
|
|
|
1. Fork the repository.
|
|
2. Modify the source; please focus on the specific change you are contributing.
|
|
If you also reformat all the code, it will be hard for us to focus on your
|
|
change.
|
|
3. Ensure local tests pass.
|
|
4. Commit to your fork using clear commit messages.
|
|
5. Send us a pull request, answering any default questions in the pull request
|
|
interface.
|
|
6. Pay attention to any automated CI failures reported in the pull request, and
|
|
stay involved in the conversation.
|
|
|
|
GitHub provides additional document on
|
|
[forking a repository](https://help.github.com/articles/fork-a-repo/) and
|
|
[creating a pull request][create-pr].
|
|
|
|
[create-pr]:
|
|
https://help.github.com/articles/creating-a-pull-request/
|
|
|
|
## Finding contributions to work on
|
|
|
|
Looking at the existing issues is a great way to find something to contribute
|
|
on. As our projects, by default, use the default GitHub issue labels
|
|
(enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any
|
|
['help wanted'](https://github.com/aws-actions/configure-aws-credentials/labels/help%20wanted)
|
|
issues is a great place to start.
|
|
|
|
## Code of Conduct
|
|
|
|
This project has adopted the
|
|
[Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct). For
|
|
more information see the
|
|
[Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
|
|
<opensource-codeofconduct@amazon.com> with any additional questions or
|
|
comments.
|
|
|
|
## Security issue notifications
|
|
|
|
If you discover a potential security issue in this project we ask that you
|
|
notify AWS/Amazon Security via our
|
|
[vulnerability reporting page][vuln-report].
|
|
|
|
[vuln-report]:
|
|
http://aws.amazon.com/security/vulnerability-reporting/
|
|
Please do **not** create a public github issue.
|
|
|
|
## Automated Tools
|
|
|
|
The use of AI tooling for assisted development work is accepted and encouraged
|
|
in this repository, but due to the volume of submissions we ask that you observe
|
|
the following rules:
|
|
|
|
- All issue and pull request submissions to this repository that are sourced by
|
|
AI must first be reviewed by a human before submitting to the repository.
|
|
Items reviewed in this way must include a statement like "generated by AI
|
|
tools, and reviewed by [person]"
|
|
- Please ensure that your submissions are actually improvements. While we are
|
|
grateful for any proposed fixes, even if they are very small, behavior that
|
|
looks like creating noisy PRs or artificially inflating submission counts
|
|
is not acceptable.
|
|
- We may close issues or pull requests, or limit your ability to interact with
|
|
this repository, for behavior that in our estimation violates these rules or
|
|
any of the other rules in this repository's
|
|
[Code of Conduct](CODE_OF_CONDUCT.md).
|
|
|
|
## Licensing
|
|
|
|
See the
|
|
[LICENSE](https://github.com/aws-actions/configure-aws-credentials/blob/main/LICENSE)
|
|
file for our project's licensing. We will ask you to confirm the licensing of
|
|
your contribution.
|
|
|
|
We may ask you to sign a
|
|
[Contributor License Agreement (CLA)](http://en.wikipedia.org/wiki/Contributor_License_Agreement)
|
|
for larger changes.
|