Skip to content

Commit

Permalink
docs: add CODE_OF_CONDUCT.md, SECURITY.md, and CONTRIBUTING.md (#1231)
Browse files Browse the repository at this point in the history
  • Loading branch information
jtieri authored Sep 18, 2024
1 parent ef77122 commit c4d7bce
Show file tree
Hide file tree
Showing 7 changed files with 264 additions and 136 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,4 @@ body:
description: By submitting this issue, you agree to follow our [Code of Conduct](../../../CODE_OF_CONDUCT.md).
options:
- label: I agree to follow this project's Code of Conduct
required: true
required: true
133 changes: 133 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,133 @@

# 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, sex characteristics, gender
identity and expression, level of experience, education, socioeconomic status,
nationality, personal appearance, race, caste, color, 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 also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official email 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
support@strange.love.
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][v2.1].

Community Impact Guidelines were inspired by
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].

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

[homepage]: https://www.contributor-covenant.org
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
[Mozilla CoC]: https://github.com/mozilla/diversity
[FAQ]: https://www.contributor-covenant.org/faq
[translations]: https://www.contributor-covenant.org/translations
89 changes: 89 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
# Contributor Guidelines

## Introduction

Welcome to the Strangelove contributor guidelines. We are excited to have you here and look forward to your contributions!
Contributors are expected to adhere to the guidelines outlined in this document as well as our [code of conduct](./CODE_OF_CONDUCT.md).

## Contributing

There are many ways to contribute, from writing tutorials or blog posts, improving the documentation,
submitting bug reports and feature requests, or writing code which can be incorporated into the project itself.

### Bug Reports

First thing to note is that if you believe you have discovered a security vulnerability *DO NOT* use the public issue tracker.
Please read our [security policy](./SECURITY.md) for more information on reporting security vulnerabilities.

When creating a bug report, please use the [template](./.github/ISSUE_TEMPLATE/bug_report.yml) and include as much
detail as possible. At a minimum be sure to include the following:
- What you were trying to do
- How the bug can be reproduced
- What you expected to happen
- What version of the software you were using

### Feature Requests & Enhancements

Feature requests and other enhancements can be made using the [template](./.github/ISSUE_TEMPLATE/feature_request.yml) provided.
Please provide as much detail as possible, including the problem you are trying to solve and the solution you would like to see,
along with possible alternatives you have considered if applicable. Understanding the use cases and the benefits the new feature
or enhancement would bring to users helps the team to prioritize and implement the feature.

### Doc Changes

Documentation changes are always welcome. If you see a typo, or would like to improve the documentation in any way feel
free to open a PR. If you are unsure about the changes you would like to make or if the changes go well beyond
addressing simple grammar mistakes or formatting, open an issue to discuss the changes before opening a PR.

### Opening PRs

When opening new PRs it is advised to open an issue first to discuss the changes you would like to make.
This helps to ensure that the changes are in line with the project goals and that the team is aware of the changes being made
so that duplicate efforts are not made and everyone's time is used efficiently.

When opening a PR, please ensure that the PR description includes the issue number that the PR is addressing.
This helps to ensure that the PR is linked to the issue and that the issue is closed when the PR is merged.


### Contributor License Agreement

Before opening a PR, please review LICENSE.md and familiarize yourself with its terms.
Please be advised that by opening a PR, you are granting Strangelove (or the owner of the relevant repository) a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable license, in copyright and in patent, with respect to your
Contribution and any portion thereof.

## Getting Started

Before you start contributing, make sure you have the following prerequisites installed:

- [Go](https://golang.org/dl/)
- [Docker](https://www.docker.com/get-started)
- [VSCode (recommended editor)](https://code.visualstudio.com/)

To get started, follow these steps:

1. Fork the interchaintest repository to your own GitHub account.

2. Clone your forked repository to your local machine:

```sh
git clone https://github.com/<Username>/interchaintest.git
```

3. Create a new branch on your fork

```sh
git checkout -b name/broad-description-of-feature
```

4. Make your changes and commit them with descriptive commit messages.

5. Test your changes locally with `go test ./...`, or by running the specific test affecting your feature or fix.

6. Push your changes to your GitHub forked repository

```sh
git push origin name/broad-description-of-feature
```

7. Create a pull request (PR) against the main branch of the interchaintest repository. If the PR is still a work-in-progress, please mark the PR as draft.
30 changes: 29 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@ DOCKER := $(shell which docker)
protoVer=0.13.2
protoImageName=ghcr.io/cosmos/proto-builder:$(protoVer)
protoImage=$(DOCKER) run --rm -v $(CURDIR):/workspace --workdir /workspace $(protoImageName)
golangci_lint_cmd=golangci-lint
golangci_version=v1.57.2
gofumpt_cmd=gofumpt
gofumpt_version=v0.6.0

default: help

Expand Down Expand Up @@ -38,4 +42,28 @@ mod-tidy: ## Run mod tidy
.PHONY: proto-gen
proto-gen: ## Generate code from protos
@echo "Generating Protobuf files"
@$(protoImage) sh ./scripts/protocgen.sh
@$(protoImage) sh ./scripts/protocgen.sh

.PHONY: lint
lint: ## Lint the repository
@echo "--> Running linter"
@if ! $(golangci_lint_cmd) --version 2>/dev/null | grep -q $(golangci_version); then \
go install github.com/golangci/golangci-lint/cmd/golangci-lint@$(golangci_version); \
fi
@$(golangci_lint_cmd) run ./... --timeout 15m

.PHONY: lint-fix
lint-fix: ## Lint the repository and fix warnings (if applicable)
@echo "--> Running linter and fixing issues"
@if ! $(golangci_lint_cmd) --version 2>/dev/null | grep -q $(golangci_version); then \
go install github.com/golangci/golangci-lint/cmd/golangci-lint@$(golangci_version); \
fi
@$(golangci_lint_cmd) run ./... --fix --timeout 15m

.PHONY: gofumpt
gofumpt: ## Format the code with gofumpt
@echo "--> Running gofumpt"
@if ! $(gofumpt_cmd) -version 2>/dev/null | grep -q $(gofumpt_version); then \
go install mvdan.cc/gofumpt@$(gofumpt_version); \
fi
@gofumpt -l -w .
12 changes: 12 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Reporting Security Issues

The Strangelove team and the IBC community take security issues seriously. We appreciate your efforts to responsibly disclose your findings, and we will make all reasonable efforts to acknowledge your contributions.

To report a security issue, please use the GitHub Security Advisory ["Report a Vulnerability"](https://docs.github.com/en/code-security/security-advisories/guidance-on-reporting-and-writing-information-about-vulnerabilities/privately-reporting-a-security-vulnerability#privately-reporting-a-security-vulnerability) tab. Please provide any data you have, and the more you can provide the more rapidly we can respond. However, do not let lack of knowledge delay your report. You may leave blank any areas of the security advisory except the detailed description of the issue, the steps to reproduce, and the version or versions you know to be affected.

The Strangelove team will send a response indicating the next steps in handling your report. After the initial reply to your report, the security team will keep you informed of the progress towards a fix and full announcement, and may ask for additional information or guidance. We may also coordinate with Amulet or other security consultants in the Cosmos/IBC space.

Report security bugs in third-party modules or plugins to the person or team maintaining the module.

The GitHub Security Advisory "Report a Vulnerability" tab should always be the first step in reporting a security related issue.
If for some reason you are unable to report through GitHub, please contact the Strangelove team at security@strange.love.
43 changes: 0 additions & 43 deletions docs/CODE_OF_CONDUCT.md

This file was deleted.

Loading

0 comments on commit c4d7bce

Please sign in to comment.