Skip to content

Commit 84e780f

Browse files
authored
Create CONTRIBUTING.md
1 parent a1fd8e6 commit 84e780f

File tree

1 file changed

+72
-0
lines changed

1 file changed

+72
-0
lines changed

CONTRIBUTING.md

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
# Contributing to JSword
2+
3+
Thank you for your interest in contributing to the JSword project! This document outlines the process and guidelines for contributing code, documentation, or other improvements.
4+
5+
## How Work Has Been Done
6+
7+
- Contributions have historically come via pull requests (PRs) to the main repository.
8+
- Issues are used to track bugs, feature requests, and ongoing work.
9+
- Code reviews are performed by project maintainers before merging.
10+
- The project aims for stability and backwards compatibility.
11+
12+
## Getting Started
13+
14+
1. **Fork the Repository**
15+
16+
Create your own fork of [crosswire/jsword](https://github.com/crosswire/jsword), then clone it to your local machine.
17+
18+
2. **Create a Branch**
19+
20+
Work on your contribution in a new branch, named descriptively (e.g., `fix-verse-range-bug` or `feature-chinese-support`).
21+
22+
3. **Code Style**
23+
24+
- Follow the existing code style and conventions.
25+
- Include Javadoc comments for public classes and methods.
26+
- Write clear, concise commit messages.
27+
28+
4. **Testing**
29+
30+
- Add or update tests to verify your change.
31+
- Ensure all tests pass before submitting a PR.
32+
33+
5. **Documentation**
34+
35+
- Update documentation as needed.
36+
- If you add a new feature, document its usage and behavior.
37+
38+
## Submitting Changes
39+
40+
1. **Open a Pull Request**
41+
42+
- Go to your fork and open a PR against `crosswire/jsword:master`.
43+
- Reference related issues in your PR description, if applicable.
44+
- Explain your changes and why they are needed.
45+
46+
2. **Respond to Feedback**
47+
48+
- Project maintainers may request changes or clarifications.
49+
- Be responsive and update your PR as needed.
50+
51+
3. **Merging**
52+
53+
- Only maintainers can merge PRs.
54+
- PRs will be merged after approval and passing tests.
55+
56+
## Reporting Issues
57+
58+
- Use [GitHub Issues](https://github.com/crosswire/jsword/issues) to report bugs or request features.
59+
- Provide as much detail as possible, including steps to reproduce, expected behavior, and relevant logs.
60+
61+
62+
## Licensing
63+
64+
- By contributing, you agree that your contributions will be licensed under the project's [license](LICENSE) and copyright by CrossWire Bible Society.
65+
66+
## Questions
67+
68+
If you have questions or need help, open an issue or join the discussion.
69+
70+
---
71+
72+
Happy coding, and thank you for helping improve jsword!

0 commit comments

Comments
 (0)