Skip to content

Latest commit

 

History

History
79 lines (48 loc) · 3.58 KB

CONTRIBUTING.md

File metadata and controls

79 lines (48 loc) · 3.58 KB

Contributing to Aurora Theme

First off, thank you for considering contributing to our project! We appreciate your interest and welcome all contributions.

The following is a set of guidelines for contributing to this project. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

How to Contribute

Reporting Bugs

If you find a bug, please create an issue in the GitHub repository. When reporting a bug, please include:

  • A clear and descriptive title for the issue.
  • Steps to reproduce the issue, including any necessary code snippets or files.
  • The expected behavior vs. the actual behavior observed.
  • Relevant details such as your environment, operating system, and the version of the project you are using.

Suggesting Enhancements

We welcome suggestions to improve the project! If you have an idea for a new feature or improvement, please submit an issue with:

  • A descriptive title for the suggestion.
  • A detailed explanation of the proposed enhancement, including how it would benefit the project and any possible drawbacks.
  • Any relevant examples or resources that demonstrate the idea.

Submitting a Pull Request

Pull requests are the best way to propose changes to the codebase. Before you submit a pull request, make sure to:

  1. Fork the repository and create your branch from main.
  2. Follow the coding standards (if any) and write tests for your changes.
  3. Ensure your code passes the existing tests.
  4. Update the documentation as needed.
  5. Submit your pull request, linking it to the relevant issue if applicable.

Please include the following in your pull request:

  • A clear description of the changes made.
  • The reason for the changes (reference any relevant issues).
  • Any additional context that might be helpful in reviewing the pull request.

Code Style

Adhering to a consistent code style helps maintain readability and collaboration. Please follow the established coding conventions of the project. If the project uses specific linters or formatting tools, make sure to run them before submitting your changes.

Branch Naming

For consistency, please use the following branch naming conventions:

  • feature/description for new features.
  • bugfix/description for bug fixes.
  • docs/description for documentation updates.
  • hotfix/description for critical fixes.

Commit Messages

  • Use clear and descriptive commit messages.
  • Follow the format: Type: Description of the change (Fixes #IssueNumber).
  • Example: Fix: Correct typo in README (Fixes #42).

Reviewing and Merging Pull Requests

Once you submit a pull request, it will be reviewed by the maintainers. We aim to provide feedback within a few days. If changes are requested, please update your pull request accordingly.

After approval, the pull request will be merged by one of the maintainers. In some cases, we may ask you to squash your commits or rebase before merging.

Contributor License Agreement (CLA)

Before your contribution can be accepted, you may be required to sign a Contributor License Agreement (CLA). This ensures that you retain ownership of your contribution while allowing us to use your code.

Community Guidelines

Please note that this project is governed by a Code of Conduct. By participating, you are expected to uphold this code.

Getting Help

If you have any questions or need help, feel free to reach out by opening an issue or contacting the maintainers.

Thank you for contributing to Aurora Theme!