Skip to content

Latest commit

 

History

History
89 lines (56 loc) · 4.05 KB

CONTRIBUTING.md

File metadata and controls

89 lines (56 loc) · 4.05 KB
Raw

Contributing to Web3Task Frontend

We would love for you to contribute to Web3Task and help make it even better than it is today! As a contributor, here are the guidelines we would like you to follow:

Code of Conduct

Help us keep Web3Task open and inclusive. Please read and follow our Code of Conduct.

Reporting Bugs

This section guides you through submitting a bug report for this project. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.

  • Use a clear and descriptive title for the issue to identify the problem.
  • Describe the exact steps which reproduce the problem in as many details as possible.

If you find a bug in the source code, you can help us by submitting an issue to our GitHub Repository. Even better, you can submit a Pull Request with a fix.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for this project, including completely new features and minor improvements to existing functionality.

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a step-by-step description of the suggested enhancement in as many details as possible.

Your First Code Contribution

Unsure where to begin contributing to this project? You can start by looking through these good first issue and dog issues:

  • good first issue - issues which should only require a few lines of code, and a test or two.
  • dog - issues which should be a bit more involved than beginner issues.

Submission Guidelines

Before you submit your Pull Request (PR) consider the following guidelines:

  1. Search GitHub for an open or closed PR that relates to your submission. You don't want to duplicate existing efforts.

  2. Be sure that an issue describes the problem you're fixing, or documents the design for the feature you'd like to add. Discussing the design upfront helps to ensure that we're ready to accept your work.

  3. Fork the repository.

  4. In your forked repository, make your changes in a new git branch:

    git checkout -b my-fix-branch main

  5. Create your patch, including appropriate test cases.

  6. Follow our Coding Rules.

  7. Commit your changes using a descriptive commit message that follows our commit message conventions. Adherence to these conventions is necessary because release notes are automatically generated from these messages.

    git commit --all

    Note: the optional commit --all command line option will automatically "add" and "rm" edited files.

  8. Push your branch to GitHub:

    git push origin my-fix-branch

  9. In GitHub, send a pull request to web3task-front:dev.

Coding Rules

To ensure consistency throughout the source code, keep these rules in mind as you are working:

  • All features or bug fixes must be tested by one or more specs (unit-tests).
  • All public API methods must be documented.

Contact

This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].