Skip to content

Latest commit

 

History

History
44 lines (27 loc) · 2.65 KB

CONTRIBUTING.md

File metadata and controls

44 lines (27 loc) · 2.65 KB

Contributing to Script Generator

Thank you for considering contributing to the OS Folder Icons project! We welcome any contributions that can help improve the project and make it even better. Whether it's reporting a bug, suggesting a new feature, or submitting a pull request, your contributions are highly appreciated.

To ensure a smooth and efficient contribution process, please follow the guidelines outlined below.

Getting Started

  1. Fork the repository on GitHub.
  2. Clone your forked repository to your local machine.
  3. Install the required dependencies by running pip install -r requirements.txt.
  4. Familiarize yourself with the project structure and documentation.

Reporting Issues

If you encounter any bugs, have questions, or want to suggest enhancements, please create a new issue on the project's GitHub repository. When reporting issues, please provide as much detail as possible, including the steps to reproduce the issue and any relevant error messages or logs.

Making Contributions

Code Contributions

  1. Before starting to work on any significant changes, create a new issue to discuss your proposed changes with the project maintainers. This helps ensure that your contribution aligns with the project goals and avoids duplicating work.
  2. Fork the repository and create a new branch for your changes.
  3. Make your changes, following the coding style and conventions used in the project.
  4. Write tests to cover your code changes, ensuring that existing tests still pass.
  5. Commit your changes with clear and descriptive commit messages.
  6. Push your branch to your forked repository.
  7. Submit a pull request to the main repository, clearly describing the changes you've made and referencing any related issues.

Documentation Contributions

Improvements to the project's documentation are highly valuable. If you find any areas that need clarification, have suggestions for new sections, or want to fix any errors, please feel free to contribute by submitting a pull request.

Reviewing and Discussing Contributions

Contributions will be reviewed by the project maintainers, who may request changes or provide feedback. Please actively engage in any discussions related to your contribution to ensure a smooth and collaborative process.

Code of Conduct

To ensure a welcoming and inclusive community, all contributors are expected to adhere to the Code of Conduct. Please familiarize yourself with the code of conduct and follow it throughout your interactions with the project.

License

By contributing to the OS Folder Icons project, you agree that your contributions will be licensed under the MIT License.