Skip to content

Latest commit

 

History

History
68 lines (39 loc) · 2.16 KB

CONTRIBUTING.md

File metadata and controls

68 lines (39 loc) · 2.16 KB

Contributing to ChronoSlots

Thank you for considering contributing to ChronoSlots! We appreciate your interest in helping us improve the project. By participating, you agree to abide by our code of conduct and to follow the guidelines outlined below.

How to Contribute

1. Reporting Issues

If you find a bug or have a feature request, please open an issue in the [issue tracker](link to the issue tracker). Be sure to include the following information:

  • A clear and descriptive title.
  • A detailed description of the issue or feature request.
  • Steps to reproduce the issue, if applicable.
  • Screenshots or code snippets, if relevant.

2. Submitting Changes

To submit changes to the project, follow these steps:

  1. Fork the Repository

Click the "Fork" button in the top right corner of the repository page.

  1. Clone Your Fork

Clone your fork to your local machine using the command:

    git clone https://github.com/daichiyoshimura/chrono-slots.git
  1. Create a Branch

Create a new branch for your feature or bug fix:

git checkout -b feature-or-bugfix-name
  1. Make Your Changes

Make the necessary changes in your local repository. Be sure to write clear, concise commit messages that describe your changes.

  1. Run Tests

Ensure that all tests pass. If you are adding new functionality, please include tests for your changes.

  1. Push Your Changes

Push your changes to your fork:

git push origin feature-or-bugfix-name
  1. Create a Pull Request

Go to the original repository and click on "New Pull Request." Select your branch and provide a description of your changes. Be sure to reference any related issues.

3. Code Style

Please follow the existing code style used in the project. Consistency helps keep the codebase maintainable and readable. If you're unsure about the coding style, feel free to check existing files or ask in the issue tracker.

4. Conduct

Please be respectful and considerate of others when contributing. We have a [Code of Conduct](link to code of conduct) that outlines our expectations for participation.

Thank you for your contributions and support for ChronoSlots!