Skip to content

Latest commit

 

History

History
66 lines (41 loc) · 3.72 KB

CONTRIBUTING.md

File metadata and controls

66 lines (41 loc) · 3.72 KB

Contributing

Thank you for considering contributing to the Aegis WordPress Block Theme! Whether you are interested in enhancing the theme's functionality with new features, creating new block patterns specifically tailored for Aegis, refining its global styles, improving the theme's code, or participating in beta testing, your contributions are always welcome.

Aegis is built to fully utilize WordPress’s Full Site Editing (FSE) capabilities, allowing for extensive customization directly within the block editor. Contributions can help enhance the theme's flexibility, performance, and user experience, making it even more robust and versatile for a diverse range of users.

To ensure a productive and positive environment, we have a few guidelines:

General Contribution Guidelines

  • No Self-Promotion: Please focus on enhancing the project rather than promoting personal content or services.
  • Adhere to WordPress Standards: All contributions must comply with the WordPress Coding Standards.

If you are unsure about anything, feel free to open an issue or a pull request for guidance. Even if your contribution needs changes, we will kindly direct you to the appropriate resources or suggest modifications to your pull request.

We aim to foster a welcoming environment for everyone involved. Therefore, all contributors are expected to follow our Code of Conduct.

How to Contribute

  1. Fork the Repository: Start by forking the Aegis repository to your GitHub account.

  2. Clone Your Fork: Clone your fork to your local machine:

    git clone https://github.com/YOUR-USERNAME/aegis.git

  3. Create a New Branch: Always create a new branch for your contributions:

    git checkout -b your-branch-name

  4. Make Your Changes: Implement your changes, following WordPress coding standards.

  5. Run Tests and Linters: Ensure your code passes all tests and adheres to coding standards:

    npm run lint
composer run lint

  6. Commit and Push: Commit your changes with a descriptive message and push them to your fork:

    git commit -m "Descriptive message of your changes"
git push origin your-branch-name

  7. Submit a Pull Request: Create a pull request (PR) to the main branch of the original repository.

Contribution Best Practices

  • Be Clear and Concise: When creating issues or pull requests, provide as much context as possible.
  • Stay Focused: Keep your commits and pull requests focused on a single issue or feature.
  • Write Meaningful Commit Messages: Use descriptive commit messages that explain the "why" of the changes, not just the "what."

Licensing and Copyright

Aegis is licensed under the GPL-2.0-or-later license. By contributing to the Aegis theme, you agree that your contributions will be released under the GPLv2 license.

You retain copyright over any contribution made to Aegis. However, by submitting a pull request, you agree to release that contribution under the GPLv2 license.

Final Notes

We value and appreciate all contributions and strive to create a positive and welcoming environment. If you have any questions or need further guidance, please feel free to reach out via an issue or discussion thread.

Thank you for contributing to Aegis and helping us build a better theme!