Skip to content

Latest commit

 

History

History
60 lines (43 loc) · 2.62 KB

CONTRIBUTING.md

File metadata and controls

60 lines (43 loc) · 2.62 KB

Contributing Guide

Thank you for considering contributing to the Tomato Timer CLI project! We appreciate your interest and support. This guide will help you get started with contributing to our project.

Table of Contents

Getting Started

To contribute to the Tomato Timer CLI project, please follow these steps:

  1. Fork the repository on GitHub.
  2. Clone your forked repository to your local machine.
  3. Install the necessary dependencies by running npm install.
  4. Make your desired changes or additions to the codebase.
  5. Test your changes to ensure they work as expected.
  6. Commit your changes with a descriptive commit message.
  7. Push your changes to your forked repository.
  8. Submit a pull request to the main repository.

Submitting Issues

If you encounter any issues or bugs while using the Tomato Timer CLI, please follow these steps to submit an issue:

  1. Go to the issue tracker on GitHub.
  2. Click on the "New Issue" button.
  3. Provide a clear and concise title for the issue.
  4. Describe the issue in detail, including steps to reproduce if applicable.
  5. Add any relevant screenshots or error messages.
  6. Assign appropriate labels and milestones if applicable.
  7. Click on the "Submit New Issue" button.

Making Pull Requests

To contribute code changes or new features to the Tomato Timer CLI, please follow these steps:

  1. Ensure that your local repository is up to date with the main repository.
  2. Create a new branch for your changes.
  3. Make your desired changes or additions to the codebase.
  4. Test your changes to ensure they work as expected.
  5. Commit your changes with a descriptive commit message.
  6. Push your changes to your forked repository.
  7. Submit a pull request to the main repository.

Code of Conduct

Please note that we have a Code of Conduct in place to ensure a positive and inclusive community. By participating in this project, you agree to abide by the Code of Conduct. Violations may result in temporary or permanent exclusion from the project.

License

The Tomato Timer CLI project is licensed under the MIT License. By contributing to this project, you agree to license your contributions under the same license.

We appreciate your contributions and look forward to your involvement in the Tomato Timer CLI project!