Skip to content

Latest commit

 

History

History
61 lines (36 loc) · 1.79 KB

CONTRIBUTING.md

File metadata and controls

61 lines (36 loc) · 1.79 KB

Contributing to Waltzes

Thank you for considering contributing to Waltzes! We welcome contributions from everyone. Here are some guidelines to help you get started.

How Can I Contribute?

Reporting Bugs

If you find a bug, please report it by opening an issue on our GitHub repository. Include as much detail as possible to help us diagnose and fix the issue quickly.

Suggesting Enhancements

We welcome suggestions for new features or improvements. Please open an issue on our GitHub repository and describe your idea in detail.

Submitting Pull Requests

  1. Fork the repository: Click the "Fork" button on the top right of the repository page.

  2. Clone your fork:

    git clone https://github.com/your-username/waltzes.git
cd waltzes

  3. Create a branch:

    git checkout -b issue-number-feature-or-bugfix-name # 13-contribution-guide OR 14-BUG-server-stops-unexpectedly

  4. Make your changes: Implement your feature or fix the bug.

  5. Commit your changes:

    git add .
git commit -m "Description of your changes"

  6. Push to your fork:

    git push origin feature-or-bugfix-name

  7. Open a pull request: Go to the original repository and click the "New pull request" button. Provide a clear description of your changes.

Code Style

Please follow the existing code style in the project. Ensure your code is clean and well-documented.

Testing

If applicable, add tests for your changes and ensure all existing tests pass. (NONE AVAILABLE AS OF RIGHT NOW)

License

By contributing to Waltzes, you agree that your contributions will be licensed under LICENSE.

Thank you for your contributions!