Skip to content

Latest commit

 

History

History
63 lines (39 loc) · 2.42 KB

CONTRIBUTING.md

File metadata and controls

63 lines (39 loc) · 2.42 KB
Raw

Contributing to The Deed Protocol

First off, thank you for considering contributing to The Deed Protocol. It's people like you that make this platform great.

Ways to Contribute

There are many ways you can directly contribute to the project:

  • Report bugs and file issues. Our project uses GitHub issues to track public bugs.
  • Suggest new features and improvements.
  • Write and help us improve our documentation.
  • Submit pull requests. If you're fixing a bug, describe the bug in detail and provide a descriptive title for the PR.

Code of Conduct

By participating in this project, you are expected to uphold our Code of Conduct.

Getting Started

Requirements

  • git
  • Node v18+
  • Yarn v3+
  • VSCode (recomanded) / WebStorm / Any web IDE

Installation & Run

  1. Clone the repo
  2. Open a terminal and run yarn install
  3. Open the project workspace in your IDE (VSCode recomanded)
  4. Open a terminal in Frontend (or packages/nextjs) and run yarn start
  5. To debug the backend, open run and debug in VSCode and select NextJS: debug server side from the dropdown.
  6. To debug the frontend, use the browser dev tools. (vscode task doesn't work yet)

Bug Reports

  • Ensure the bug was not already reported by searching on GitHub under Issues.
  • If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

Feature Requests

  • Open a new issue. Use the correct template for feature request issues. Be sure to include a detailed description of the feature, why this feature is needed, and how it can be used.

Pull Requests

  • Fill in the required template
  • Follow the coding style of the project
  • Separate unrelated changes into multiple pull requests

Please read the Pull Request Guidelines before submitting your pull request.

Code style

  • Please use the .eslintrc configuration file in the project for the code style settings.

License

By contributing to The Deed Protocol, you agree that your contributions will be licensed under its AGPL-3.0 License.

Questions

If you have further questions, you can check out the FAQ, ask a question on the GitHub Discussions page, or join our community on Discord.