Skip to content

Latest commit

 

History

History
51 lines (32 loc) · 2.52 KB

CONTRIBUTING.md

File metadata and controls

51 lines (32 loc) · 2.52 KB
Raw

Contributing to Spritesheet Cruncher

Thank you for your interest in contributing to Spritesheet Cruncher! We welcome contributions from all levels of experience, whether you're a seasoned developer or just starting out.

Here are some guidelines to help you get started:

1. Issues:

  • If you find a bug or have a feature request, please open an issue on the repository.
  • Be sure to provide a clear and concise description of the issue, including steps to reproduce it.
  • If you have any suggestions for how to fix the issue or implement the feature, please include them as well.

2. Pull Requests:

  • Before you start working on a pull request, please check the existing issues to see if there is already one for your proposed change.
  • If there is not, please create a new issue and discuss your idea with the maintainers.
  • Once you have a good understanding of what needs to be done, fork the repository and create a new branch for your changes.
  • Make sure your code is well-documented and follows the existing coding style.
  • Write unit tests for your changes.
  • Submit a pull request to the main repository.

3. Coding Style:

  • We use Python's standard style guide, PEP 8.
  • Please use spaces instead of tabs for indentation.
  • Wrap lines at 80 characters.
  • Use descriptive variable names and docstrings.

4. Contact:

  • You can contact the maintainers of Spritesheet Cruncher by creating a Discussion on the repository or by DMing them on Discord (@lyubomirt).
  • You can also join The Orange Squad Discord server (https://discord.gg/dwCE2RdUZ3) to chat with other contributors and the maintainers.

We appreciate your contributions to Spritesheet Cruncher!

Additional Notes:

  • Please feel free to suggest improvements to this contributing guide.
  • We are always looking for ways to improve Spritesheet Cruncher, so don't hesitate to share your ideas.

We hope this guide helps you make valuable contributions to Spritesheet Cruncher!

License

This project is licensed under the BSD 3-Clause License. See the LICENSE: LICENSE file for more information.

Contact

You can contact me by creating a Discussion on the repository or by DMing me on Discord (@lyubomirt). I will try to respond as soon as possible, but I can't guarantee that I will respond immediately. If you want to contact me about a bug, please open an issue instead. Additionally, you can join my Discord server: https://discord.gg/dwCE2RdUZ3 since I'm usually online there.

We crank spritesheets!