Skip to content

Latest commit

 

History

History
53 lines (34 loc) · 2.95 KB

CONTRIBUTING.md

File metadata and controls

53 lines (34 loc) · 2.95 KB

Contributing to OpenBangla Keyboard (OBK)

Thank you for your interest in contributing to OpenBangla Keyboard! We welcome contributions of all kinds, whether it's code, documentation, bug reports, feature requests, or helping fellow contributors.

Please take a moment to review this guide before submitting your contribution.

Code of Conduct

We expect all contributors to adhere to our Code of Conduct. Please read it carefully and ensure you understand and agree to its terms.

How Can I Contribute?

There are many ways you can contribute to this project:

Reporting Bugs

If you encounter a bug, please help us by submitting a detailed issue. When reporting a bug, please include:

  • A clear and descriptive title for the issue.
  • Steps to reproduce the bug as precisely as possible.
  • What you expected to happen instead of the actual outcome.
  • Any relevant environment information, such as your operating system, software versions, and any specific configurations.
  • If possible, include any error messages or screenshots that might be helpful.

Suggesting Enhancements

We are always open to suggestions for new features and improvements. When suggesting an enhancement, please consider:

  • Clearly describe the proposed enhancement and its benefits.
  • Explain the use case and why you believe this enhancement would be valuable.
  • If possible, suggest how the enhancement might be implemented.
  • Check if a similar feature request already exists before creating a new one.

Contributing Code or Documentation

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

  1. Fork the repository on your GitHub account
  2. Clone your fork to your local machine
  3. Create a new branch for your changes and choose a descriptive name (e.g., feature/smth, fix/smth)
  4. Make your changes and ensure your code follows the project's coding style (if applicable)
  5. Add your changes to Git
  6. Commit your changes with a clear and concise commit message. It's highly encouraged follow Conventional Commits for commit messages which will help us to auto-generate CHANGELOG.md
  7. Push your branch to your fork on GitHub
  8. Create a Pull Request (PR) targeting OBK's develop branch and while creating your PR, it's highly appreciated if you follow Semantic PR conventions

NOTE: All documentation for OBK will be managed in the OpenBangla/manual repository. Its contribution guidelines are the preferred and prioritized source for documentation contributions.

Questions?

If you have any questions about contributing, feel free to ask in GitHub Discussions!

Thank you again for your contribution! We appreciate your time and effort in making OBK better.