feat: Add CONTRIBUTING.md

This commit introduces a `CONTRIBUTING.md` file to establish clear guidelines for developers who wish to contribute to the project. The file is based on a template provided by the project owner and has been adapted for the `ComfyUI-ChristmasTheme` repository. It includes sections on: - How to report bugs and suggest enhancements, with correct links to the issue tracker. - The contribution workflow for submitting pull requests. - A link to the Contributor Covenant Code of Conduct. This will help streamline the contribution process and encourage community involvement.
2026-01-09 13:39:23 +00:00
parent 8c4a4f7b3e
commit 3464c05f47
1 changed files with 51 additions and 0 deletions
@@ -0,0 +1,51 @@
+# Contributing to ComfyUI Christmas Theme
+
+First off, thank you for considering contributing to the ComfyUI Christmas Theme! Your help is greatly appreciated.
+
+## How Can I Contribute?
+
+There are many ways to contribute, from reporting bugs to suggesting new features or submitting pull requests.
+
+### Reporting Bugs
+
+If you encounter a bug, please open an issue on our [GitHub issue tracker](https://github.com/AEmotionStudio/ComfyUI-ChristmasTheme/issues). Please include the following information:
+
+- A clear and descriptive title.
+- A detailed description of the bug, including steps to reproduce it.
+- Your ComfyUI version and browser information.
+- Any relevant screenshots or error messages.
+
+### Suggesting Enhancements
+
+If you have an idea for a new feature or an improvement to an existing one, please open an issue on our [GitHub issue tracker](https://github.com/AEmotionStudio/ComfyUI-ChristmasTheme/issues). Please include the following information:
+
+- A clear and descriptive title.
+- A detailed description of the proposed enhancement.
+- Any relevant mockups or examples.
+
+### Pull Requests
+
+We welcome pull requests! If you'd like to contribute code, please follow these steps:
+
+1. Fork the repository.
+2. Create a new branch for your changes (`git checkout -b feature/your-feature-name`).
+3. Make your changes and commit them with a clear and descriptive commit message.
+4. Push your changes to your fork (`git push origin feature/your-feature-name`).
+5. Open a pull request to the `main` branch of this repository.
+
+Please ensure your code follows the existing code style and that you've tested your changes.
+
+## Development
+
+The project is a mix of Python and JavaScript.
+
+- The Python code is located in the `__init__.py` file.
+- The JavaScript code is in the `js` directory.
+
+When making changes, please ensure you are editing the source files.
+
+## Code of Conduct
+
+By participating in this project, you are expected to uphold our [Code of Conduct](CODE_OF_CONDUCT.md).
+
+Thank you for your contributions!