Contributing Guide

We value curiosity, enthusiasm, and determination. Anyone who is excited about state channels and our vision is welcome to contribute to Connext. While we’re always looking for developers, there are plenty of other ways to contribute through documentation, design, marketing, and even translation. If you’re not sure how best to contribute, reach out to a team member and we’ll be happy to find a way for you to help out.

Our documentation includes information on Ethereum and state channels for both part-time and core contributors to the project, while LearnChannels provides a comprehensive introduction to state channel technology.

Feel free to fork our repo and start creating PR’s after assigning yourself to an issue in the repo. We are always chatting on Discord, so drop us a line there if you want to get more involved or have any questions on our implementation!

We encourage contributors to:

  • Engage in Discord conversations and questions on how to begin contributing to the project

  • Open up github issues to express interest in code to implement

  • Open up PRs referencing any open issue in the repo. PRs should include:

    • Detailed context of what would be required for merge

    • Tests that are consistent with how other tests are written in our implementation

    • Proper labels, milestones, and projects (see other closed PRs for reference)

  • Follow up on open PRs

  • Have an estimated timeframe to completion and let the core contributors know if a PR will take longer than expected

  • We do not expect all part-time contributors to be experts on all the latest documentation, but all contributors should at least be familiarized with our documentation and LearnChannels.

Contribution Steps

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct, please follow it in all your interactions with the project.

Our pull request workflow is as follows:

  1. Ensure any install or build dependencies are removed before the last commit.

  2. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.

  3. Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent. The versioning scheme we use is SemVer.

  4. You should sign your commits if possible with GPG.

  5. Commits should be atomic changes with clear code comments and commit messages.

  6. All builds must be passing, new functionality should be covered with tests.

  7. Once you commit your changes, please tag a core team member to review them.

  8. You may merge the Pull Request in once you have the sign-off of at least one core team member, or if you do not have permission to do that, you may request the reviewer to merge it for you.

Code of Conduct

Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making 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 both within project spaces and in public spaces when an individual is representing the project or its community. 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 support@connext.network. 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 here