Skip to content

CONTRIBUTING.MD

Latest commit

 

History

History
70 lines (54 loc) · 2.72 KB

CONTRIBUTING.MD

File metadata and controls

70 lines (54 loc) · 2.72 KB

Contributing to ScriptureFlow API

First of all: thank you for your interest in contributing! 🙏
We’re excited to welcome developers, translators, documentation authors and other collaborators to the ScriptureFlow project.

How you can contribute

We welcome contributions of all kinds:

  • Reporting bugs
  • Suggesting or implementing new versions/translations
  • Improving documentation
  • Adding tests, examples or SDKs
  • Helping to triage or close issues

If you’re not sure where to start, browse our issue tracker and look for issues tagged good-first-issue or help-wanted.

Your first contribution

  1. Fork the repository.
  2. Create a new branch: git checkout --branch my-feature.
  3. Make your changes (follow any existing code/style conventions).
  4. Commit your changes: git commit -m "Add <feature> to ScriptureFlow".
  5. Push the branch to your fork: git push origin my-feature.
  6. Open a Pull Request to this repository’s main branch.
    • Provide a clear title and description.
    • Link to any relevant issue (if applicable).
    • Include tests/screenshots/documentation updates where relevant.

Pull Request Guidelines

  • Ensure the code builds and passes any existing tests.
  • If you’re adding a translation/version, follow the folder structure (bibles/<version>/…).
  • Use meaningful commit messages.
  • Be open to feedback and revision — maintainers may request changes.
  • You may be asked to rebase or merge main changes before your PR is merged.
  • Reviews may take 1–2 weeks — thanks for your patience.

Style & Formatting

  • Use spaces, not tabs (unless project dictates otherwise).
  • Follow existing naming conventions for files and folders.
  • For JSON schema changes, update documentation accordingly.
  • When applicable, add or update tests/examples to reflect new behavior.

Issue Guidelines

  • Before creating a new issue, search existing issues to avoid duplicates.
  • Provide a clear and descriptive title.
  • For bugs: include steps to reproduce, expected vs. actual behavior, version used, environment.
  • For enhancement requests: describe the benefit, proposed approach, any constraints.

Community & Support

Need help?

  • Post your question in the issue tracker with the tag question.
  • Check the FAQ in the README for quick answers.
  • Be respectful in all communications — we adhere to our Code of Conduct.

License & Attribution

By contributing you agree that your contributions will be licensed under the project’s MIT License.
See LICENSE for details.
Original project © Henok Woldesenbet, enhancements © 2025 Johnathan Lightfoot / ScriptureFlow Project.