Skip to content

Latest commit

 

History

History
56 lines (33 loc) · 2 KB

CONTRIBUTING.md

File metadata and controls

56 lines (33 loc) · 2 KB

Contributing to TickWatch

We're thrilled that you're interested in contributing to TickWatch! By following these guidelines, you can help ensure a smooth and collaborative contribution process.

How to Contribute

  1. Fork the repository on GitHub.
  2. Clone your forked repository to your local machine:
git clone https://github.com/HichemTab-tech/TickWatch-js.git
  1. Create a new branch for your contribution:
git checkout -b feature/your-feature-name
  1. Make your changes and commit them:
git commit -m "Add your descriptive commit message here"
  1. Push your changes to your forked repository:
git push origin feature/your-feature-name
  1. Open a pull request (PR) on GitHub. Provide a clear and descriptive title, and include details about the changes you've made in the PR description.

Code Style and Standards

Please ensure that your code adheres to the coding standards and style guidelines used in the project. If there are existing code conventions, follow them consistently to maintain code consistency across the project.

Testing

Before submitting your changes, make sure that your new features are tested.

Issues and Bug Reports

If you find a bug or have an issue, please check the existing issues on GitHub to see if it has already been reported. If not, feel free to open a new issue with a clear description and steps to reproduce the problem.

Feature Requests

We welcome new ideas and feature requests! If you have a feature you'd like to propose, open a new issue on GitHub and provide a detailed explanation of the feature's purpose and benefits.

Licensing

By contributing to this project, you agree that your contributions will be licensed under the project's LICENSE.

Contact

If you have any questions or need further assistance, you can reach out to the maintainers at [email protected].