Skip to content

Commit 8070c29

Browse files
author
Reshad Ahammed Ayon
authored
docs: simplify and improve CONTRIBUTING.md (#422)
* docs: simplify and improve CONTRIBUTING.md Removes verbose git command examples and integrates documentation contribution steps. Adds emphasis on Conventional Commits and Semantic PR to align with modern best practices for version control and PR management. * docs: add note about external documentation repository * fix: typo and improve wording
1 parent b1a3a6f commit 8070c29

File tree

1 file changed

+11
-68
lines changed

1 file changed

+11
-68
lines changed

CONTRIBUTING.md

Lines changed: 11 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -31,77 +31,20 @@ We are always open to suggestions for new features and improvements. When sugges
3131
- **If possible, suggest how the enhancement might be implemented.**
3232
- **Check if a similar feature request already exists** before creating a new one.
3333

34-
### Contributing Code
34+
### Contributing Code or Documentation
3535

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

38-
1. **Fork the repository** on GitHub.
39-
2. **Clone your fork** to your local machine:
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
4046

41-
```bash
42-
git clone --recursive https://github.com/OpenBangla/OpenBangla-Keyboard.git
43-
cd OpenBangla-Keyboard
44-
```
45-
46-
3. **Create a new branch** for your changes. Choose a descriptive name:
47-
48-
```bash
49-
git checkout -b feature/your-feature-name
50-
# or
51-
git checkout -b bugfix/your-bug-fix
52-
```
53-
54-
4. **Make your changes** and ensure your code follows the project's coding style (if any).
55-
5. **Add your changes** to Git:
56-
57-
```bash
58-
git add .
59-
```
60-
61-
6. **Commit your changes** with a clear and concise commit message. Follow these guidelines for commit messages:
62-
63-
- Separate the subject from the body with a blank line.
64-
- Try limiting the subject line to 50 characters.
65-
- Do not end the subject line with a period.
66-
- Use the imperative mood ("Fix bug", "Add feature").
67-
- Optionally, provide a more detailed body for context.
68-
69-
```bash
70-
git commit -m "Add feature: Implement bangla spell checker"
71-
```
72-
73-
7. **Push your branch** to your fork on GitHub:
74-
75-
```bash
76-
git push origin your-feature-name
77-
```
78-
79-
8. **Create a Pull Request (PR)** through the GitHub website. When creating a PR:
80-
81-
- Provide a clear and descriptive title for your PR.
82-
- In the description, explain the changes you've made and the problem they solve (if applicable).
83-
- Reference any related issues in the PR description (e.g., `Closes #123`, `Fixes #456`).
84-
85-
### Contributing Documentation
86-
87-
Good documentation is crucial! We have a dedicated repository for OpenBangla Keyboard documentation: https://github.com/OpenBangla/manual. Most documentation contributions should be made there, unless it's something that is related to this repository. If you'd like to contribute to the documentation:
88-
89-
- **Submit issues** for any unclear or incorrect documentation you find.
90-
- **Create pull requests** to fix typos, improve clarity, or add new documentation. Follow the same Git workflow as contributing code. Ensure your documentation changes are well-formatted (e.g., using AsciiDoc or Markdown).
91-
92-
`Note: The contribution guidelines in the OpenBangla/manual repository are the preferred and prioritized source for documentation contributions.`
93-
94-
## Pull Request Guidelines
95-
96-
To ensure your pull request is reviewed and merged efficiently, please follow these guidelines:
97-
98-
- **Target your pull request to the `develop` branch** (or the designated development branch), not the `main` branch.
99-
- **Keep your PR focused** on a single issue or feature. Avoid making unrelated changes in the same PR.
100-
- **Ensure your code builds and passes all tests** (if applicable).
101-
- **Follow the project's coding style** and conventions.
102-
- **Write clear and concise commit messages.**
103-
- **Provide a detailed description** in your pull request explaining your changes and their purpose.
104-
- **Be responsive to feedback** during the code review process.
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.
10548
10649
## Questions?
10750

0 commit comments

Comments
 (0)