Thank you for your interest in contributing to Convrtr! We welcome all kinds of contributions — bug reports, feature requests, documentation improvements, and code. Convrtr is a passion project, and every contribution helps make it that little bit better. Please read through the guidelines below to understand how to contribute effectively.
How to contribute
Reporting a bug
- Spot something weird? First, check if it’s already been reported in Issues.
- Not there? Open a new issue and give it a clear title.
- Tell us what happened — what you expected to happen vs. what actually happened.
- Include steps to reproduce the bug, if you can. The more descriptive you can be, the better.
- Screenshots or error messages? Super helpful!
- Mention your setup — browser, OS, version, anything that might help us debug.
Thanks for helping us squash bugs and make Convrtr better!
Reporting a security issue
- Found a security bug? Thank you for looking out for us!
- Please don’t open a public issue. Instead, submit an issue to our security tracker.
- Alternatively, you can email us privately at [security@convrtr.xyz]
- Include as much detail as you can — what you found, how to reproduce it, and why it’s a concern.
- We’ll review it quickly and get back to you as soon as possible.
- Responsible disclosure is appreciated — we’ll credit you if you'd like (or keep it anonymous).
For more information, please see our Security section on GitHub. Thanks for helping keep Convrtr safe and secure!
Suggesting a new feature, tool or enhancement
- Got an idea? Awesome — we’d love to hear it!
- Check the Issues tab to see if someone’s already suggested it.
- If not, open a new issue and give it a clear, descriptive title.
- Make sure to tag it as a feature request
- Tell us what the feature is, why it would be useful, and who it helps.
- Bonus points for sketches, mockups, or examples!
Thanks for helping shape the future of the project!
Making your contribution
Fork the repository
Click the Fork button at the top right of the GitHub page to create your own copy of the repository. Alternatively, you can click this link to go directly to the fork page: https://github.com/stickerboy/convrtrjs/fork
You can optionally change the name and description, or leave it as is depending on what your goals are.
Clone your fork
Use the following command to clone your forked repository to your local machine:
git clone https://github.com/your-username/your-fork.git
Create a branch
Create a new branch for your changes:
git checkout -b my-feature
Make your changes
Make your changes locally. Please follow the existing code style and add tests if applicable.
Commit your changes
git add .
git commit -m "Describe your changes"
Push to your fork
git push origin my-feature
Open a pull request
Go to the original repository and open a Pull Request from your branch. Please describe your changes and link any related issues, it will be reviewed as soon as possible.
Guidelines
- Be respectful and constructive.
- Write clear, concise commit messages.
- Update documentation as needed.
- If you’re fixing a bug, please include steps to reproduce it.
Need help?
If you have any questions, feel free to open an issue on Github or start a discussion on our Discord server.
Thank you for helping improve this project!