Skip to content

Latest commit

 

History

History
45 lines (36 loc) · 2.61 KB

CONTRIBUTING.md

File metadata and controls

45 lines (36 loc) · 2.61 KB

Contributing to Web Metrics

Thank you for considering contributing to Web Metrics! We welcome contributions from the community to help improve and grow this tool. Whether you want to report a bug, suggest an enhancement, or submit code changes, please follow these guidelines to ensure a smooth contribution process.

Table of Contents

How to contribute

There are several ways to contribute to this project:

Reporting Bugs

If you encounter a bug while using this tool, please report it by creating an issue. Be sure to provide as much detail as possible, including the steps to reproduce the issue, the environment you're using, and any error messages.

Suggesting Enhancements

If you have an idea for how to improve this tool, please create an issue to describe your suggestion. Be sure to provide as much detail as possible, including examples of how the enhancement would work and how it would benefit other users.

Submitting Code Changes

If you would like to contribute code changes to this project, please follow these steps:

  1. Fork this repository.
  2. Create a branch for your changes.
  3. Make your changes and commit them with descriptive commit messages.
  4. Push your changes to your forked repository.
  5. Create a pull request to submit your changes for review.
  6. Wait for your pull request to be reviewed and merged.

Commit Messages

Please use descriptive commit messages that clearly describe the changes you are making. Follow the Conventional Commits format if applicable.

Testing

Please ensure that your code changes include tests that cover the new functionality and verify that existing features remain functional. If relevant, update the documentation to reflect the changes.

Documentation

Keep the project documentation up to date. If you make changes that affect user behavior, provide updates to the documentation.