Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
72 lines (42 loc) · 2.25 KB

CONTRIBUTING.md

File metadata and controls

72 lines (42 loc) · 2.25 KB

Contributing to JSword

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.

How Work Has Been Done

  • Contributions have historically come via pull requests (PRs) to the main repository.
  • Issues are used to track bugs, feature requests, and ongoing work.
  • Code reviews are performed by project maintainers before merging.
  • The project aims for stability and backwards compatibility.

Getting Started

  1. Fork the Repository

    Create your own fork of crosswire/jsword, then clone it to your local machine.

  2. Create a Branch

    Work on your contribution in a new branch, named descriptively (e.g., fix-verse-range-bug or feature-chinese-support).

  3. Code Style

    • Follow the existing code style and conventions.
    • Include Javadoc comments for public classes and methods.
    • Write clear, concise commit messages.

  4. Testing

    • Add or update tests to verify your change.
    • Ensure all tests pass before submitting a PR.

  5. Documentation

    • Update documentation as needed.
    • If you add a new feature, document its usage and behavior.

Submitting Changes

  1. Open a Pull Request

    • Go to your fork and open a PR against crosswire/jsword:master.
    • Reference related issues in your PR description, if applicable.
    • Explain your changes and why they are needed.

  2. Respond to Feedback

    • Project maintainers may request changes or clarifications.
    • Be responsive and update your PR as needed.

  3. Merging

    • Only maintainers can merge PRs.
    • PRs will be merged after approval and passing tests.

Reporting Issues

  • Use GitHub Issues to report bugs or request features.
  • Provide as much detail as possible, including steps to reproduce, expected behavior, and relevant logs.

Licensing

  • By contributing, you agree that your contributions will be licensed under the project's license and copyright by CrossWire Bible Society.

Questions

If you have questions or need help, open an issue or join the discussion.

Happy coding, and thank you for helping improve jsword!