Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
86 lines (55 loc) · 2.78 KB

CONTRIBUTING.md

File metadata and controls

86 lines (55 loc) · 2.78 KB

Contributing to UserStyles

Thank you for considering contributing to UserStyles! We appreciate your support and look forward to your contributions. Please follow these guidelines to ensure a smooth and efficient contribution process.

Table of Contents

Code of Conduct

Please adhere to our Code of Conduct to ensure a welcoming and respectful environment for everyone.

How to Contribute

Reporting Bugs

If you find a bug, please report it by opening an issue. Provide as much detail as possible to help us understand and reproduce the issue.

Feature Requests

We welcome feature requests! Please open an issue with your suggestion and provide a clear and detailed description of the feature and why it would be beneficial.

Submitting Changes

  1. Fork the repository.
  2. Create a new branch with a descriptive name (e.g., feature/new-theme).
  3. Make your changes in the new branch.
  4. Test your changes thoroughly.
  5. Commit your changes with a descriptive commit message.
  6. Push your branch to your forked repository.
  7. Open a pull request to the main repository.

Issue Tracking

Issues are used to track bugs, enhancements, and feature requests. Please provide detailed information when opening an issue.

Creating Pull Requests

When creating a pull request, please ensure the following:

  • Your code follows the project's style guidelines.
  • Your changes are well-documented.
  • Your changes have been tested thoroughly.

Pull Request Checklist

  • Descriptive title and summary.
  • Followed style guidelines.
  • Updated documentation.
  • Linked to the related issue.

Style Guidelines

Please adhere to the following style guidelines:

  • Use spaces for indentation (4 spaces per indent level).
  • Write clear and concise comments.
  • Follow the naming conventions used in the existing code.

Commit Messages

Write clear and concise commit messages. The first line should be a brief summary of the changes, followed by a blank line, and then a more detailed explanation if necessary.

Example:

feat: Add new theme

This commit introduces a new theme to the application.
The theme is based on the Material Design guidelines and
provides a modern and visually appealing user interface.

Testing

Ensure that your changes are thoroughly tested before submitting a pull request. Write unit tests and integration tests to verify the correctness of your code.

License

This project is licensed under the MIT License - see the LICENSE file for details.