diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..32c25015 --- /dev/null +++ b/.gitignore @@ -0,0 +1,19 @@ +# Local environment files +.venv/ +.venv +.vscode/ +.idea/ +__pycache__/ +*.pyc +*.pyo +*.pyd + +# Jupyter +.ipynb_checkpoints/ + +# OS files +.DS_Store +Thumbs.db + +# Logs +*.log diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8ac3edd7..4c3ad42b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,59 +1,53 @@ # 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. +Thank you for your interest in contributing to AWS CodeConnections. This fork is maintained by @MIahamed05, and we welcome feedback, bug reports, feature suggestions, and improvements from the community. +Please review this guide before opening an issue or submitting a pull request so we can respond quickly and keep the process consistent. ## 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](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public GitHub issue. - -## Reporting Bugs/Feature Requests +If you discover a potential security issue, please report it privately through the AWS vulnerability reporting process rather than opening a public issue. See [SECURITY.md](SECURITY.md) for full instructions. -We welcome you to use the GitHub issue tracker to report bugs or suggest features. +## Reporting bugs or requesting features -When filing an issue, please check existing open, or recently closed, issues to make sure somebody else hasn't already -reported the issue. Please try to include as much information as you can. Details like these are incredibly useful: +We welcome issue reports and enhancement requests through GitHub. -* 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 +Before opening a new issue, please: +- check whether a similar issue already exists +- include clear reproduction steps or context +- provide affected version or environment details +- describe expected vs. actual behavior +- include logs, screenshots, or examples when helpful -## Contributing via Pull Requests -Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that: +## Contributing via pull requests -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. +Contributions via pull requests are appreciated. Before submitting a pull request, please ensure that: -To send us a pull request, please: +1. You are working from the latest available code. +2. You have checked for existing work that may already address the issue. +3. You have opened or referenced the relevant issue when needed. +4. Your change is focused and does not include unrelated formatting or refactoring. +5. Relevant local validation or tests pass. -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. +To submit a pull request: -GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and -[creating a pull request](https://help.github.com/articles/creating-a-pull-request/). +1. Fork the repository or use the appropriate working branch. +2. Make the change with a clear, targeted scope. +3. Commit with clear, descriptive messages. +4. Open a pull request using the repository template. +5. Address any feedback and monitor for CI or review comments. +GitHub has helpful documentation for [forking repositories](https://help.github.com/articles/fork-a-repo/) and [creating pull requests](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' issues is a great place to start. +## Finding work to contribute +A good place to start is by reviewing open issues and looking for labels such as help wanted, enhancement, or bug. Community contributions are especially welcome when they improve reliability, documentation, or developer experience. -## 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. +## Code of conduct +This project follows the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct). See the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) for more information or contact opensource-codeofconduct@amazon.com with questions. ## Licensing -See the LICENSE file for our project's licensing. We will ask you to confirm the licensing of your contribution. +Please ensure all contributions are compatible with the repository's licensing terms. We may ask contributors to confirm licensing status as part of the review process. diff --git a/ISSUE_TEMPLATE/bug_report.md b/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..5c4e4400 --- /dev/null +++ b/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,37 @@ +--- +name: Bug report +about: Create a report to help us improve +title: "" +labels: bug +assignees: "" +--- + +## Summary + +A clear and concise description of what the bug is. + +## Steps to reproduce + +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +## Expected behavior + +A clear and concise description of what you expected to happen. + +## Actual behavior + +A clear and concise description of what actually happened. + +## Environment + +- OS: +- Browser/Runtime: +- Version/Commit: +- Relevant configuration: + +## Additional context + +Add any other context, screenshots, logs, or examples here. diff --git a/ISSUE_TEMPLATE/feature_request.md b/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..ea248664 --- /dev/null +++ b/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,23 @@ +--- +name: Feature request +about: Suggest an idea or enhancement +title: "" +labels: enhancement +assignees: "" +--- + +## Problem + +Describe the problem or limitation you are trying to solve. + +## Proposed solution + +Describe the solution you would like to see. + +## Alternatives considered + +Describe any alternative solutions or workarounds that you considered. + +## Additional context + +Add any relevant examples, references, mockups, or supporting details. diff --git a/PULL_REQUEST_TEMPLATE b/PULL_REQUEST_TEMPLATE index 6bdaa999..4d77e277 100644 --- a/PULL_REQUEST_TEMPLATE +++ b/PULL_REQUEST_TEMPLATE @@ -1,6 +1,24 @@ -*Issue #, if available:* +## Summary -*Description of changes:* +Describe the purpose of this change and the problem it addresses. +## Related issue(s) -By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice. +- Issue #: +- Related PRs: + +## Changes made + +- [ ] Describe the key code or documentation changes +- [ ] Include tests or validation where relevant +- [ ] Note any breaking changes or migration steps + +## Verification + +Describe how this was validated locally or in CI. + +## Notes + +Add any additional context, screenshots, or follow-up work here. + +By submitting this pull request, I confirm that I am able to license this contribution under the repository's license and agree to the project contribution terms. diff --git a/README.md b/README.md new file mode 100644 index 00000000..f32b9ef0 --- /dev/null +++ b/README.md @@ -0,0 +1,30 @@ +# AWS CodeConnections .github Repository + +This repository is owned by @MIahamed05 and contains the GitHub community health and contribution metadata for the AWS CodeConnections project and organization. + +## What this repository is for + +This is a repository for GitHub configuration rather than application source code. It provides the standard organization-level settings used when contributors interact with the project, including: + +- contribution guidance +- issue templates +- pull request templates +- security disclosure instructions +- code of conduct and community policy + +## Included files + +- [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) — community expectations and standards +- [CONTRIBUTING.md](CONTRIBUTING.md) — guidance for contributors +- [PULL_REQUEST_TEMPLATE](PULL_REQUEST_TEMPLATE) — default pull request checklist +- [SECURITY.md](SECURITY.md) — responsible disclosure process +- [ISSUE_TEMPLATE/bug_report.md](ISSUE_TEMPLATE/bug_report.md) — bug report template +- [ISSUE_TEMPLATE/feature_request.md](ISSUE_TEMPLATE/feature_request.md) — feature request template + +## When to use this repo + +Use this repository for GitHub metadata and project workflow settings. Any implementation, application code, or project source files should live in the main project repository that uses these community standards. + +## Contribution notes + +Before opening an issue or pull request, please review the contributing guide and the relevant issue template. For security concerns, do not open a public issue; follow the process described in [SECURITY.md](SECURITY.md).