Skip to content

Latest commit

 

History

History
37 lines (23 loc) · 1.68 KB

contributing.md

File metadata and controls

37 lines (23 loc) · 1.68 KB

Contributing to Darkvoid Theme Ecosystem

Thank you for your interest in contributing to the Darkvoid theme ecosystem! We welcome contributions to enhance and expand the theme across different editors, terminals, and applications.

How to Contribute

1. Opening Issues

  • If you find a bug or have an idea for improvement, feel free to open an issue. Be sure to provide a detailed description of the problem or feature request.
  • Check if the issue has already been reported before creating a new one.

2. Making a Pull Request

  • Fork the repository you wish to contribute to.
  • Create a new branch for your feature or bugfix (e.g., feature/add-new-port).
  • Ensure that your code follows the existing style of the repository and passes any automated checks.
  • Submit a pull request with a clear description of the changes you've made.

3. Adding New Ports

  • If you want to port Darkvoid to a new application (editor, terminal, etc.), create a new repository under the darkvoid-theme organization.
  • Make sure to follow the structure used in other ports (installation instructions, preview images, etc.).
  • Once your port is ready, submit a pull request to link it to the main darkvoid-theme ecosystem.

4. Testing Your Changes

  • Before submitting your PR, make sure to test it thoroughly in the environment it is intended for.
  • You can provide screenshots or videos to show that the theme looks good in the target application.

5. Code Style

  • Follow the style guidelines of the repository you're contributing to.

Additional Guidelines

  • Be respectful of others' opinions and contributions.
  • Maintain a friendly and welcoming environment for all contributors.