Contributing to Inkporter

Hey, thanks for considering contributing to Inkporter! Your help is what makes this project better. Whether you’ve found a bug, have a feature idea, or want to help with some code, we’d love to have you involved!

How to Contribute

1. Reporting Bugs

If you run into any bugs:

Check the existing issues first to see if it’s already been reported.
If it’s a new issue, just open a new one and provide:
- A brief and clear title.
- Steps to reproduce.
- Expected vs actual behavior.
- Any helpful screenshots or logs.

2. Suggesting Features

Have a cool feature idea?

Look through the issues to see if anyone else suggested it.
If it’s not there, feel free to open a new issue labeled enhancement and tell us:
- What problem does it solve?
- How do you imagine it working?
- Any examples or mockups are always appreciated!

3. Contributing Code

Want to fix a bug or add a feature?

Fork the repository and clone it to your local machine.

Create a new branch for your changes:

git checkout -b feature/your-feature-name

Make your changes and commit them with a simple message:

git commit -m "Add: Brief description of your change"

Push your branch:

git push origin feature/your-feature-name

Open a pull request:
- Let us know what you’ve changed.
- If it’s related to any open issues, link them up!

Code Guidelines

Keep the code style consistent with what’s already there.
Commit messages should be short and descriptive.
If you’re adding something complex, a comment or two would be super helpful!
Please test your changes to make sure everything works smoothly.

1.7 KiB Raw Permalink Blame History Unescape Escape