Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
samriddhi99 committed Jun 26, 2024
1 parent ab4fe10 commit 0c469e9
Show file tree
Hide file tree
Showing 2 changed files with 65 additions and 6 deletions.
23 changes: 18 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ little bit helps, and credit will always be given.

The following is a set of guidelines for contributing to Tirith on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

## Join the StackGuardian Community
We'd love for you to join our community! Join our [Slack](#https://join.slack.com/t/stackguardian-ol78820/shared_invite/zt-2ksag36j9-OjmXqQmyXudgYrV6FmesIQ) to ask questions, share ideas, and connect with other contributors. Follow us on [LinkedIn](#https://www.linkedin.com/company/stackguardian/posts/?feedView=all) to stay updated on the latest news and announcements.

## Contribution types

### Report Bugs
Expand All @@ -28,13 +31,23 @@ Please use GitHub Discussions to submit feedback and engage with community [http

## Basic guidelines

For all changes you commit or submit by pull-request please follow these simple guidelines:
### Pull Requests

- **Stay Updated**: Make sure your PR is based on the latest code from the `main` branch.
- **Clear Title and Description**: Try to include a clear, descriptive title and a detailed explanation of your changes.
- **Reference Issues**: If applicable, link to related issues and PRs.
- **Pass Tests**: Ensure all tests pass before submitting your PR.
- **Be Open to Feedback**: We're all here to help each other improve, so please be open to feedback and ready to make adjustments.

### Issues

- **Search First**: It helps to check if your problem or feature request has already been discussed before opening a new issue.
- **Be Detailed**: When you open a new issue, providing as much detail as possible really helps. Feel free to use our templates for bugs and feature requests.
- **Be Respectful**: Let's all be kind and considerate in our communication.

Thank you for taking the time to help improve our project!

### Advice on pull requests:

- Raise Pull Request as soon as you start working on a feature, bug, test or hotfix and label it with `work-in-progress`, while it is not ready to be merged.
- Commits or squashed commits in your pull-requests should have a useful description.
- Always update CHANGELOG.md before merging Pull Requests.

### If you have commit access:

Expand Down
48 changes: 47 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Tirith scans declarative Infrastructure as Code (IaC) configurations like Terraf
- [Example Tirith policies](#example-tirith-policies)
- [Terraform Plan](#terraform-plan-provider)
- [Infracost](#infracost-provider)
- [StackGuardian Workflow Policy](#)
- [StackGuardian Workflow Policy](#stackguardian-workflow-policy-using-sg-workflow-provider)
- []
- [Kubernetes](#kubernetes)
- [Want to contribute?](#want-to-contribute)
Expand Down Expand Up @@ -435,6 +435,52 @@ Example Input:
Output:
![](https://github.com/StackGuardian/tirith/blob/updating_readme/docs/sg_workflow_example.gif)


JSON Output:

```json

{
"meta": {
"version": "v1",
"required_provider": "stackguardian/sg_workflow"
},
"final_result": false,
"evaluators": [
{
"id": "wf_check_1",
"passed": true,
"result": [
{
"passed": true,
"message": "True is equal to True",
"meta": null
}
],
"description": null

},

...

{
"id": "wf_check_11",
"passed": false,
"result": [
{
"passed": false,
"message": "True is not equal to False",
"meta": null
}
],
"description": null
},

],
"errors": [],
"eval_expression": "wf_check_1 && wf_check_2 && wf_check_3 && wf_check_4 && wf_check_5 && wf_check_6 && wf_check_7 && wf_check_8 && wf_check_9 && wf_check_10 && wf_check_11 && wf_check_12 && wf_check_13 && wf_check_14"
}
```
4. Make sure that all AWS ELBs are attached to security group (using Terraform plan provider)

```json
Expand Down

0 comments on commit 0c469e9

Please sign in to comment.