Skip to content

Commit

Permalink
feat: Update repo metadata
Browse files Browse the repository at this point in the history
  • Loading branch information
asyrafnorafandi committed Sep 11, 2024
1 parent d4e8971 commit f964851
Show file tree
Hide file tree
Showing 8 changed files with 282 additions and 53 deletions.
42 changes: 42 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
name: Bug report
about: Report a bug to help us improve
title: "bug: <description>"
labels: "kind/bug"
assignees: ""
---

> [!CAUTION]
> Remember to redact any sensitive information such as authentication credentials or license keys.
**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:

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.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Environment:**

- Module Version: [e.g. 1.0.0]
- Terraform Version: [e.g. 0.14.5]
- Provider Version: [e.g. AWS 3.0]

**Additional context**
Add any other context about the problem here.

**Open Source Acknowledgment**

- [ ] I understand that this is an open-source project maintained by volunteers. While the team will make efforts to
address this issue, I acknowledge that there may not be an immediate resolution, and the issue might not be addressed
if it doesn't align with the project's goals or resources.
48 changes: 0 additions & 48 deletions .github/ISSUE_TEMPLATE/bug_report.yml

This file was deleted.

25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
name: Feature request
about: Suggest a feature or enhancement
title: "feat: <description>"
labels: "kind/enhancement"
assignees: ""
---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. "I am always frustrated when [...]"

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.

**Open Source Acknowledgment**

- [ ] I understand that this is an open-source project maintained by volunteers. While the team will make efforts to
address this issue, I acknowledge that there may not be an immediate resolution, and the issue might not be addressed
if it doesn't align with the project's goals or resources.
22 changes: 22 additions & 0 deletions .github/PULL_REQUEST/pull_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
name: Pull Request
about: Suggest changes or fixes to the codebase
title: "feat: <description>"
labels: "kind/enhancement"
assignees: ""
---

**Description**
A clear and concise description of the changes proposed in this pull request.

**Related Issues**
Reference any related issues or pull requests here.

**Checklist**

- [ ] Code compiles and tests are passing.
- [ ] Documentation is updated (if necessary).
- [ ] Tests are added or updated to cover changes.

**Additional Information**
Include any additional information or context that might be helpful for the reviewers.
79 changes: 79 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our community include:

- Demonstrating empathy and kindness toward other people
- Being respectful of differing opinions, viewpoints, and experiences
- Giving and gracefully accepting constructive feedback
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
- Focusing on what is best not just for us as individuals, but for the overall community

Examples of unacceptable behavior include:

- The use of sexualized language or imagery, and sexual attention or advances of any kind
- Trolling, insulting or derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or email address, without their explicit permission
- Other conduct which could reasonably be considered inappropriate in a professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.

Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and it also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at [[email protected]](mailto:[email protected]). All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series of actions.

**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within the community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html).

Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).

For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq). Translations are available at [https://www.contributor-covenant.org/translations](https://www.contributor-covenant.org/translations).

[homepage]: https://www.contributor-covenant.org
64 changes: 64 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
# Contributing to AWS EC2 Group Module

Thank you for considering contributing to this project! We welcome contributions from the community and aim to make it as easy as possible to get involved.

## Code of Conduct

This project adheres to the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [[email protected]](mailto:[email protected]).

## Reporting Issues

If you encounter a bug, performance issue, or have a question, please check our [issue tracker](https://github.com/asyrafnorafandi/terraform-aws-ec2-group/issues) and ensure the issue has not been reported already. If it hasn't, feel free to [open a new issue](.github/ISSUE_TEMPLATE/bug_report.md).

## How to Contribute

1. **Fork the repository** and create your branch from `main`.
2. **Write clear and concise code** that follows our [style guide](STYLE_GUIDE.md).
3. **Test your changes** to ensure the module behaves as expected.
4. **Create a pull request** following the template provided.
- Include a clear description of what the PR changes.
- Reference the issue number your PR is related to (if applicable).
- Ensure that your changes follow the [Coding Guidelines](#coding-guidelines).
5. **Wait for reviews** and address any feedback.

## Submitting Pull Requests

All pull requests should:

- Be based on the latest `main` branch.
- Include tests for the proposed changes.
- Pass all checks (linting, testing).
- Provide a detailed description of the change and its impact.

## Coding Guidelines

To ensure consistency across the codebase, please adhere to the following standards:

- **Code Formatting:** You can run the following command to format your code:

```bash
terraform fmt
```

- **Commit Messages:** Follow [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) for commit messages. For example:
- `fix: resolve navbar alignment issue`
- `feat: add user authentication`

---

## Testing

Please make sure all tests pass before submitting a PR. If you add new functionality, include corresponding unit/integration tests.

- **Run Tests:**

```bash
terraform init
terraform test
```

- **End-to-End Testing:** If applicable, ensure your changes work across various environments by adding E2E tests.

---

Thank you for contributing!
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Terraform Module Template
# Terraform Module - AWS EC2 Group

This repository is a boilerplate to start writing your own Terraform Module
Terraform module to create a group of multiple EC2 instances with monitoring. Useful for deploying multiple blockchain nodes.

## Features:

Expand Down Expand Up @@ -78,11 +78,12 @@ You are all set to go to write your custom Terraform Module! 🚀
---

<!-- BEGIN_TF_DOCS -->

## Requirements

| Name | Version |
|------|---------|
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.0 |
| Name | Version |
| ------------------------------------------------------------------------ | ------- |
| <a name="requirement_terraform"></a> [terraform](#requirement_terraform) | >= 1.0 |

## Providers

Expand All @@ -103,4 +104,5 @@ No inputs.
## Outputs

No outputs.

<!-- END_TF_DOCS -->
43 changes: 43 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Security Policy

We take security seriously and appreciate your efforts to responsibly disclose vulnerabilities.

## Supported Versions

We release updates to the latest major version and may backport critical security patches to prior versions.

| Version | Supported |
| ------- | ------------------ |
| x.x.x | :white_check_mark: |
| <x.x.x | :x: |

## Reporting a Vulnerability

If you discover a security vulnerability, please report it privately by emailing us at [[email protected]](mailto:[email protected]). Please do **not** open an issue publicly on the repository as this might compromise the security.

We will respond as soon as possible and work with you to resolve the issue.

## Security Updates

When security vulnerabilities are patched, we will:

1. Announce the fix in the repository’s release notes.
2. Increment the version number and tag the release.
3. Notify the community via [communication channels, e.g., email, social media].

We encourage all users to update to the latest version whenever a security patch is released.

## Scope

We are committed to addressing vulnerabilities in:

- The core codebase of the project.
- Dependencies and third-party libraries used within the project.

However, vulnerabilities that arise from misconfiguration or improper usage outside of our control (e.g., deploying the application with insecure settings) are not covered under this policy.

## Contact

If you have any security-related questions or need further clarification, please contact us at [[email protected]](malto:[email protected]).

Thanks for helping keep the project secure!

0 comments on commit f964851

Please sign in to comment.