Skip to content

Latest commit

 

History

History
58 lines (36 loc) · 3.12 KB

CONTRIBUTING.md

File metadata and controls

58 lines (36 loc) · 3.12 KB
Raw

Contributing to the Effect Network

Thank you for taking the time to contribute! 🎉👍

The following is a set of guidelines for contributing to the Effect Network. These are just guidelines, not rules, use your best judgment and feel free to propose changes to this document in a pull request.

Table of Contents

How To Contribute

Reporting Issues

Before submitting an issue, please go through the list below as you might find a solution to your issue.

Before Submitting an Issue

  • Make sure you get the latest version of the code to see if this resolves your issue.
  • Go through all issues on this repository to see if the issue has already been created. It could have been closed with a resolution, so check closed issues, too.
  • Chat with us in the #developer-chat channel on Discord to see if we can find a solution to the problem!
  • Determine which repository the problem should be reported in.

Determining the Repository

There are several repositories being used for Effect Network, which makes it difficult to determine which one to report an issue to. Don't worry if you aren't sure, we can always move it!

  • The Effect Network repository is a repository for all things related to the Effect Network smart contracts.
  • The Force Frontend contains all of the code that is related to the what workers interact with.
  • Effect DAO is the frontend for the DAO of Effect Network. If you find an issue with this app, please submit the issue here.

Submitting the Issue

  • Use a clear and descriptive title for the issue to identify the problem. This makes it easier for others to find.
  • Describe the exact steps to reproduce the problem with as many details as needed.

Submitting a Pull Request

Guidelines for Submitting

When in doubt, keep your pull requests small. To give a PR the best chance of getting accepted, do not bundle more than one "feature" or bug fix per PR. Doing so makes it very hard to accept it if one of the fixes has issues.

It's always best to create two smaller PRs than one big one.

Talk to us before creating a PR that refactors the code or directory structure of the project. This project is constantly changing to reflect the latest version of Effect Network so sometimes it will be in the process of getting fixed.

Code Style

Make sure to follow the existing code style as much as possible.