Skip to content

Commit 4e281a6

Browse files
codayonmominul
authored andcommitted
docs: add contributing guidelines
1 parent 645462d commit 4e281a6

1 file changed

Lines changed: 53 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# Contributing to OpenBangla Keyboard (OBK)
2+
3+
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.
4+
5+
Please take a moment to review this guide before submitting your contribution.
6+
7+
## Code of Conduct
8+
9+
We expect all contributors to adhere to our [Code of Conduct](CODE_OF_CONDUCT.md). Please read it carefully and ensure you understand and agree to its terms.
10+
11+
## How Can I Contribute?
12+
13+
There are many ways you can contribute to this project:
14+
15+
### Reporting Bugs
16+
17+
If you encounter a bug, please help us by submitting a detailed issue. When reporting a bug, please include:
18+
19+
- **A clear and descriptive title** for the issue.
20+
- **Steps to reproduce the bug** as precisely as possible.
21+
- **What you expected to happen** instead of the actual outcome.
22+
- **Any relevant environment information**, such as your operating system, software versions, and any specific configurations.
23+
- **If possible, include any error messages or screenshots** that might be helpful.
24+
25+
### Suggesting Enhancements
26+
27+
We are always open to suggestions for new features and improvements. When suggesting an enhancement, please consider:
28+
29+
- **Clearly describe the proposed enhancement** and its benefits.
30+
- **Explain the use case** and why you believe this enhancement would be valuable.
31+
- **If possible, suggest how the enhancement might be implemented.**
32+
- **Check if a similar feature request already exists** before creating a new one.
33+
34+
### Contributing Code or Documentation
35+
36+
If you'd like to contribute code or documentation, please follow these steps:
37+
38+
1. **Fork the repository** on your GitHub account
39+
2. **Clone your fork** to your local machine
40+
3. **Create a new branch** for your changes and choose a descriptive name (e.g., feature/smth, fix/smth)
41+
4. **Make your changes** and ensure your code follows the project's coding style (if applicable)
42+
5. **Add your changes** to Git
43+
6. **Commit your changes** with a clear and concise commit message. It's highly encouraged follow [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) for commit messages which will help us to auto-generate `CHANGELOG.md`
44+
7. **Push your branch** to your fork on GitHub
45+
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](https://pulsar.apache.org/contribute/develop-semantic-title/) conventions
46+
47+
> NOTE: All documentation for OBK will be managed in the [OpenBangla/manual](https://github.com/OpenBangla/manual) repository. Its contribution guidelines are the preferred and prioritized source for documentation contributions.
48+
49+
## Questions?
50+
51+
If you have any questions about contributing, feel free to ask in [GitHub Discussions](https://github.com/OpenBangla/OpenBangla-Keyboard/discussions)!
52+
53+
Thank you again for your contribution! We appreciate your time and effort in making OBK better.

0 commit comments

Comments
 (0)