Skip to content

Latest commit

 

History

History
56 lines (34 loc) · 1.49 KB

CONTRIBUTING.md

File metadata and controls

56 lines (34 loc) · 1.49 KB
Raw

Contributing to yume

Thank you for considering contributing to yume! Please take a moment to review the following guidelines.

Code of Conduct

This project and everyone participating in it are governed by the Code of Conduct. By participating, you agree to uphold this code. Please report unacceptable behavior to [your email or a dedicated email for issues].

How to Contribute

  1. Fork the repository.

  2. Clone the forked repository to your local machine:

    git clone https://github.com/zaibutcooler/yume.git

  3. Create a new branch for your feature or bug fix:

    git checkout -b feature-name

  4. Make your changes and commit them with a descriptive commit message:

    git add .
git commit -m "Add your descriptive message here"

  5. Push the changes to your fork:

    git push origin feature-name

  6. Create a pull request (PR) from your fork to the main repository.

  7. Ensure your PR title and description are clear and concise.

Reporting Issues

If you find any issues or have suggestions, please open an issue on the Issue Tracker.

Style Guide

  • Follow the existing coding style.
  • Use meaningful variable and function names.
  • Write clear and concise documentation.

License

By contributing, you agree that your contributions will be licensed under the MIT License. See the LICENSE file for details.

Thank you for contributing to yume!