-
Notifications
You must be signed in to change notification settings - Fork 93
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: contributing + code of conduct (#208)
* fix go test * add code of conduct * Adds Contributing
- Loading branch information
1 parent
91b1e51
commit 0a99656
Showing
4 changed files
with
133 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| # 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 <[email protected]>. 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 <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,86 @@ | ||
| # Contributing to Horcrux | ||
|
|
||
| Welcome to the Horcrux project! We're thrilled that you're interested in contributing. Horcrux a multi-party-computation signing service for CometBFT nodes. This document outlines the process and guidelines for contributing to Horcrux. Please read it carefully to ensure that you understand our workflow and the standards we expect for our community. | ||
|
|
||
| ## 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/) | ||
| - [Make](https://www.gnu.org/software/make/) | ||
|
|
||
| To get started, follow these steps: | ||
|
|
||
| 1. Fork the Horcrux repository to your own GitHub account. | ||
|
|
||
| 2. Clone your forked repository to your local machine: | ||
|
|
||
| ```sh | ||
| git clone https://github.com/<Username>/horcrux.git | ||
| ``` | ||
|
|
||
| 3. Crate 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 `make test`, or by running the specific test affecting your feature or fix. | ||
| 6. You can validate your changes with `make build` or `make install`. | ||
| 7. Push your changes to your github forked repository | ||
|
|
||
| ```sh | ||
| git push origin name/broad-description-of-feature | ||
| ``` | ||
|
|
||
| 8. Create a pull request (PR) against the main branch of the Horcrux 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. | ||
| 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 Horcrux a continued valuable resource. If you have any questions or need assistance, feel free to reach out to the maintainers, community members, or <[email protected]>. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters