Contributing to vite-plugin-readable-classnames

We're excited that you're interested in contributing to the vite-plugin-readable-classnames! All types of contributions are welcome: bug reports, feature requests, documentation updates, and code improvements.

Reporting Bugs

Before reporting a bug, please check if it has already been reported. You can search through existing issues here.

If you find a new issue and believe it's a bug, please open a new issue. Include as many details as possible, describe the problem, and provide steps to reproduce it, ideally with code or screenshots.

Code Contributions

If you'd like to contribute code, follow these steps:

1. Fork the repository and create your branch from main.
2. Make your changes and commit them. Try to adhere to the commit message conventions of the project.
3. Submit a Pull Request with a description of your changes.
4. Wait for the review and be prepared to make further changes if requested.

Coding Rules

Please follow the coding style of the project:

• Use 2 spaces for indentation.
• Stick to existing patterns and practices used within the project.
• Document new methods or complex sections of code.

Testing

Ensure all tests pass and write new tests if necessary for your changes. Tests help ensure the stability of the plugin and prevent future regressions.

Conclusion

Your contributions are highly valuable to the project, and we appreciate your time and efforts. If you have any questions or need assistance, feel free to reach out to the project maintainers.