From ef77122038d9257f6f195fb0dfde6725b1f09c93 Mon Sep 17 00:00:00 2001 From: Justin Tieri <37750742+jtieri@users.noreply.github.com> Date: Tue, 17 Sep 2024 18:12:07 -0500 Subject: [PATCH 1/3] chore: add issue and pull request templates (#1232) --- .github/ISSUE_TEMPLATE/bug_report.yml | 42 +++++++++++++++++++ .github/ISSUE_TEMPLATE/docs_issue.yml | 31 ++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.yml | 26 ++++++++++++ .github/ISSUE_TEMPLATE/unclassified.yml | 20 +++++++++ .../pull_request_template.MD | 29 +++++++++++++ 5 files changed, 148 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/docs_issue.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml create mode 100644 .github/ISSUE_TEMPLATE/unclassified.yml create mode 100644 .github/PULL_REQUEST_TEMPLATE/pull_request_template.MD diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 000000000..3ad34ce67 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,42 @@ +name: Bug Report +description: File a bug report. +title: "[Bug]: " +labels: ["bug", "triage"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + - type: textarea + id: what-happened + attributes: + label: What happened and what did you expect to happen? + placeholder: Tell us what you see! + validations: + required: true + - type: textarea + id: reproduce + attributes: + label: Describe how to reproduce the bug + placeholder: Step by step method to recreate the issue. + validations: + required: true + - type: input + id: Version + attributes: + label: version + description: What version of the software are you using? + - type: textarea + id: logs + attributes: + label: Relevant logs or stack trace + description: Please copy and paste any relevant output from the code. This will be automatically formatted so no need for backticks. + render: shell + - type: checkboxes + id: terms + attributes: + label: Code of Conduct + 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 diff --git a/.github/ISSUE_TEMPLATE/docs_issue.yml b/.github/ISSUE_TEMPLATE/docs_issue.yml new file mode 100644 index 000000000..d4975292a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/docs_issue.yml @@ -0,0 +1,31 @@ +name: Docs Issue +description: Report an error or omission in the documentation. +title: "[Docs]: " +labels: ["docs", "triage"] +body: + - type: markdown + attributes: + value: Thanks for taking the time to let us know how we can improve the docs! + - type: input + id: docs_page_link + attributes: + label: What page needs improvement? + value: Link a URL + - type: textarea + id: description + attributes: + label: Description + description: Please describe the way the docs didn't meet your needs. + - type: textarea + id: remedy + attributes: + label: Remedy + description: Please describe what you think needs to be added or changed for the docs to meet your needs. + - type: checkboxes + id: terms + attributes: + label: Code of Conduct + 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 diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 000000000..61892f3a7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,26 @@ +name: Feature Request +description: Request an enhancement or new feature +title: "[Feature]: " +body: + - type: textarea + id: inspiration + attributes: + label: Inspiration + description: What are you trying to accomplish but finding hard or not possible? + placeholder: What's your end goal? + validations: + required: true + - type: textarea + id: valueadd + attributes: + label: Use Cases and Audiences + description: What new possibilities does this feature enable, and what types of users will find it helpful? + placeholder: Who is the audience and what new applications would this feature enable? + - type: checkboxes + id: terms + attributes: + label: Code of Conduct + 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 diff --git a/.github/ISSUE_TEMPLATE/unclassified.yml b/.github/ISSUE_TEMPLATE/unclassified.yml new file mode 100644 index 000000000..da4ab3d6a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/unclassified.yml @@ -0,0 +1,20 @@ +name: Unclassified Issue +description: Open an issue +title: "[Unclassified]: " +labels: ["unclassified", "triage"] +body: + - type: markdown + attributes: + value: Please open a Feature Request, Docs, or Bug Report issue, but if none of those are applicable you can use this generic form. + - type: textarea + id: description + attributes: + label: Issue Description + - type: checkboxes + id: terms + attributes: + label: Code of Conduct + 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 diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.MD b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.MD new file mode 100644 index 000000000..dbc708e85 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.MD @@ -0,0 +1,29 @@ +### What kind of change does this PR introduce?** (Bug fix, feature, docs update, ...) + +--- +### What is the current behavior? (You can also link to an open issue here) + +--- +### What is the new behavior (if this is a feature change or bug fix) + +--- +### Does this PR introduce a breaking change? +If so, please describe what changes users might need to make as a result of this PR. + +--- +### Associated Issues +Give a link to the relevant open issue(s) this PR addresses in this repository and others. If it resolves an issue, use `closes: #ddd`. + +--- +### Required for all PRs: + +- [ ] I have read and agree to follow the [Code of Conduct](../../../CODE_OF_CONDUCT.md) for this project. +- [ ] I have read and followed the guidelines in the [Contributor's Guide](../../../CONTRIBUTING.md). +- [ ] I understand I should follow the guidelines in the [Security Guide](../../../SECURITY.md) for any security-related issues or PRs. +- [ ] I have checked to ensure there aren't other open [Pull Requests](../../../pulls) for the same update/change. +- [ ] If applicable, I have written the appropriate tests for my new code. +- [ ] If applicable, I have updated the appropriate documentation for new, updated, deprecated, or removed functionality. +- [ ] I have run the linter on my code prior to submitting the PR. +- [ ] All tests are passing locally for me. +- [ ] My PR has a valid [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/#summary) title +--- From c4d7bce4fb6ca17c3e9483b6784617ffaa419e1d Mon Sep 17 00:00:00 2001 From: Justin Tieri <37750742+jtieri@users.noreply.github.com> Date: Wed, 18 Sep 2024 01:55:20 -0500 Subject: [PATCH 2/3] docs: add CODE_OF_CONDUCT.md, SECURITY.md, and CONTRIBUTING.md (#1231) --- .github/ISSUE_TEMPLATE/bug_report.yml | 2 +- CODE_OF_CONDUCT.md | 133 ++++++++++++++++++++++++++ CONTRIBUTING.md | 89 +++++++++++++++++ Makefile | 30 +++++- SECURITY.md | 12 +++ docs/CODE_OF_CONDUCT.md | 43 --------- docs/CONTRIBUTING.md | 91 ------------------ 7 files changed, 264 insertions(+), 136 deletions(-) create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md create mode 100644 SECURITY.md delete mode 100644 docs/CODE_OF_CONDUCT.md delete mode 100644 docs/CONTRIBUTING.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 3ad34ce67..8507ac1e4 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -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 \ No newline at end of file diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 000000000..a2ba284f9 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -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 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..33c0c91c3 --- /dev/null +++ b/CONTRIBUTING.md @@ -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//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. \ No newline at end of file diff --git a/Makefile b/Makefile index 1a19705db..d7cf6b1e7 100644 --- a/Makefile +++ b/Makefile @@ -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 @@ -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 \ No newline at end of file + @$(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 . \ No newline at end of file diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 000000000..da8f2f279 --- /dev/null +++ b/SECURITY.md @@ -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. diff --git a/docs/CODE_OF_CONDUCT.md b/docs/CODE_OF_CONDUCT.md deleted file mode 100644 index 84c2b32af..000000000 --- a/docs/CODE_OF_CONDUCT.md +++ /dev/null @@ -1,43 +0,0 @@ -# Contributor Covenant Code of Conduct - -## Our Pledge - -In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation. - -## Our Standards - -Examples of behavior that contributes to creating a positive environment include: - -- Using welcoming and inclusive language -- Being respectful of differing viewpoints and experiences -- Gracefully accepting constructive criticism -- Focusing on what is best for the community -- Showing empathy towards other community members - -Examples of unacceptable behavior by participants include: - -- The use of sexualized language or imagery and unwelcome sexual attention or advances -- Trolling, insulting/derogatory comments, and personal or political attacks -- Public or private harassment -- Publishing others’ private information, such as a physical or electronic address, without explicit permission -- Other conduct which could reasonably be considered inappropriate in a professional setting - -## Our Responsibilities - -Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. - -Project maintainers 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, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. - -## Scope - -This Code of Conduct applies within all project spaces, and it also applies when an individual is representing the project or its community in public spaces. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. - -## Enforcement - -Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at . All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. - -Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project’s leadership. - -## Attribution - -This Code of Conduct is adapted from the Contributor Covenant, version 1.4, available at diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md deleted file mode 100644 index 1f665094c..000000000 --- a/docs/CONTRIBUTING.md +++ /dev/null @@ -1,91 +0,0 @@ -# Contributing to Interchaintest - -Welcome to the Interchaintest project! We're thrilled that you're interested in contributing. Interchaintest is an end-to-end testing framework designed to empower the IBC (Inter-Blockchain Communication) ecosystem, and your contributions can help make it even more robust and valuable for networks and developers alike. - -## Table of Contents - -- [Code of Conduct](#code-of-conduct) -- [Getting Started](#getting-started) -- [Contributing Guidelines](#contributing-guidelines) -- [Issues](#issues) -- [Pull Requests](#pull-requests) -- [Responsibilities of a PR Reviewer](#responsibilities-of-a-pr-reviewer) - -## Code of Conduct - -Please review our [Code of Conduct](./CODE_OF_CONDUCT.md) to understand the standards and expectations for participating in our community. We are committed to fostering a welcoming and inclusive environment. - -## 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//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. - -## Contributing Guidelines - -- Adhere to the project's coding style and conventions. -- Write clear and concise commit messages and PR descriptions. -- Be responsive to feedback and collaborate with others. -- Document code and include appropriate tests. -- For documentation or typo fixes, submit separate PRs. -- Keep PRs focused on a single issue or feature. - -## Issues - -We welcome bug reports, feature requests, and other contributions to our project. To open an issue, please follow these guidelines: - -1) Search existing issues: Before opening a new issue, please search existing issues to ensure that is not a duplicates. - -2) Provide a clear and descriptive title: This helps others understand the nature of the issue at a glance. - -3) Provide detailed information: In the issue description, clearly state the purpose of the issue and follow the guidelines of the issue template - -4) A maintainer will take care of assigning the appropriate labels to your issue, if applicable. - -## Pull requests - -In almost all cases, you should target branch `main` with your work. In the event it spans multiple releases, we will backport to the previous release branch as well. This can be found in our [READMEs maintained branches](../README.md#maintained-branches). - -For internal branches, branch names should be prefixed with the author's name followed by a short description of the feature, eg. `name/feature-x`. - -Pull requests are made against `main` and are squash-merged into main after approval. All CI pipeline test must pass for this to be the case. - -## Responsibilities of a PR Reviewer - -As a PR reviewer, your primary responsibility is to guide the PR through to completion. This entails not only identifying and addressing issues within the PR but also taking a leadership role in resolving any decisions necessary for the PR to be merged successfully. - -In cases where you are assigned as a reviewer for a PR that pertains to an unfamiliar part of the codebase, it's perfectly acceptable to delegate the review to a more knowledgeable colleague, provided they are willing to assume that responsibility. This ensures that the PR receives expert attention and increases the likelihood of its successful merging. Collaboration and teamwork are key in maintaining code quality and project progress. - ---- - -We appreciate your contributions and look forward to working with you to make Interchaintest a valuable resource for the IBC community. If you have any questions or need assistance, feel free to reach out to the maintainers, community members, or . From ed1e4366839bb3b8a36e2be74fd00161b058f016 Mon Sep 17 00:00:00 2001 From: Luca Palla <100412354+LucaPalla95@users.noreply.github.com> Date: Wed, 18 Sep 2024 16:17:09 +0200 Subject: [PATCH 3/3] Fix StakingQueryDelegationsTo function (#1262) --- chain/cosmos/module_staking.go | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/chain/cosmos/module_staking.go b/chain/cosmos/module_staking.go index f37ef4f17..ce3afbb22 100644 --- a/chain/cosmos/module_staking.go +++ b/chain/cosmos/module_staking.go @@ -109,8 +109,8 @@ func (c *CosmosChain) StakingQueryDelegationsTo(ctx context.Context, validator s } var delegations []*stakingtypes.DelegationResponse - for _, d := range res.DelegationResponses { - delegations = append(delegations, &d) + for i := range res.DelegationResponses { + delegations = append(delegations, &res.DelegationResponses[i]) } return delegations, nil