amadeusssystem_Inkporter/CONTRIBUTING.md
2025-01-28 22:10:35 +05:30

1.7 KiB
Raw Blame History

Contributing to Inkporter

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


How to Contribute

1. Reporting Bugs

If you run into any bugs:

  1. Check the existing issues first to see if its already been reported.
  2. If its 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?

  1. Look through the issues to see if anyone else suggested it.
  2. If its 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?

  1. Fork the repository and clone it to your local machine.
  2. Create a new branch for your changes:
    git checkout -b feature/your-feature-name
    
  3. Make your changes and commit them with a simple message:
    git commit -m "Add: Brief description of your change"
    
  4. Push your branch:
    git push origin feature/your-feature-name
    
  5. Open a pull request:
    • Let us know what youve changed.
    • If its related to any open issues, link them up!

Code Guidelines

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