Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
37 lines (24 loc) · 1.42 KB

CONTRIBUTING.md

File metadata and controls

37 lines (24 loc) · 1.42 KB

Contribution Guide

Thank you for your interest in contributing to WebEcoAnalyzer! We welcome all kinds of contributions, including reporting bugs, suggesting features, improving documentation, or submitting code.

How to Contribute

  1. Report Bugs or Suggest Features
    Please open an issue on the Issues page and provide as much detail as possible.

  2. Branch and Pull Request Workflow

    • Fork this repository and create a new branch on your fork (name the branch after the feature or fix).
    • Commit your changes and make sure all tests pass.
    • Submit a Pull Request, describing your changes and motivation.

  3. Code Style

    • Please follow the existing code style of the project.
    • It is recommended to use Prettier or ESLint for formatting.
    • For TypeScript, please add type annotations where possible.

  4. Testing

    • If you add new features or fix bugs, please add or update relevant unit tests.
    • Run npm test to ensure all tests pass.

  5. Documentation

    • If you add new features, please update the README.md or related documentation accordingly.

Code of Conduct

Please follow our Code of Conduct to help us maintain a welcoming and friendly community.

Contact

If you have any questions, feel free to open an issue or contact the project maintainers.

Thank you for your participation and support!