Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
72 changes: 61 additions & 11 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,17 +1,67 @@
/target
# JSword uses Gradle for build and project management.
# Files specific to IDEs can be generated by from build.gradle.kts and should not be checked in.
# See README.md for more details.

# Gradle
/.gradle/
/build/

# Maven
/target/
pom.xml.tag
pom.xml.releaseBackup
pom.xml.versionsBackup
pom.xml.next
release.properties

# Ant
/dist/
/ivy/
/lib/
/tools/
/bin/
/report/
*.jar
*.war
*.ear

# Eclipse
.classpath
.settings/*
.project
.settings/
*.launch
/ivy
/lib
/tools
/bin
/report

# IntelliJ IDEA
.idea/
*.iml
*.iws
out/
atlassian-ide-plugin.xml

# VS Code
.vscode/

# OS files
.DS_Store
Thumbs.db

# Logs
*.log

# Backup and patch files
*.orig
.idea
*~
*.swp
*.swo
*.bak

# Rebel
rebel.xml

/.gradle/
/build/
atlassian-ide-plugin.xml
# Node (if using JS tooling)
/node_modules/
npm-debug.log
yarn-error.log

# Generated files
*.class
72 changes: 72 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
# 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](https://github.com/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](https://github.com/crosswire/jsword/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](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!
Loading