Skip to content

Commit

Permalink
chore: contributing guidelines, PR and issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
arrocke committed Nov 26, 2024
1 parent 939473c commit bcbe655
Show file tree
Hide file tree
Showing 4 changed files with 121 additions and 0 deletions.
29 changes: 29 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Contributing to Global Bible Tools

Thank you for your interest in contributing to Global Bible Tools! Please familiarize yourself with this document before you open a PR. Accepted PRs are automatically deployed to globalbibletools.com.

## Getting Started

### Issues

#### Creating Issues
If you have an idea or find a bug, [create an issue](https://github.com/globalbibletools/platform/issues/choose) after you've already searched the issues to see if one already exists.

#### Working on an issue
Issues in the Ready column of the [project](https://github.com/orgs/globalbibletools/projects/1/views/1) are ready to be worked on. Pick from these issues to have a greater chance of having your PR accepted.

Create a branch from the main branch either in your [fork](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo#fork-an-example-repository) or in project repo to do your work in.

### Pull Requests

#### Opening a Pull Request
When you have a change that is ready for review, open a PR on GitHub to the main branch. Please note that there is no guarantee a PR will be accepted. Maintainers have limited time, so low quality PRs are likely to be rejected.

* Fill in the PR template to ensure the reviewer has everything necessary for the review
* Use [conventional commits as your PR name](https://www.conventionalcommits.org/en/v1.0.0/). The most common prefixes we use are `feat:`, `refactor:`, `chore:`, and `docs:`.
* [Link the PR](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) to the issue for reference.
* If opening a PR from a fork, [allow the reviewer to make updates to your branch](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork). This can speed up the review process.
* The reviewer may ask for changes. Please make those changes and then mark each comment as resolved when complete. Request a new review when all work is complete.

#### Merged Pull Request
Congratulations on your contribution! It is much appreciated. Once accepted and merged, your PR will be immediately deployed to globalbibletools.com and be available to all users.
41 changes: 41 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
name: Bug Report
description: Report a problem with the site.
labels:
- bug
body:
- type: checkboxes
id: terms
attributes:
label: Precheck
description: Please read through these checks before submitting a bug.
options:
- label: I have searched the issues list for similar issues.
required: true

- type: textarea
attributes:
label: Description
description: |
Please include the following:
- Description of the buggy behavior
- Description of the expected behavior
- Steps to reproduce the buggy behavior
validations:
required: true

- type: textarea
attributes:
label: Screenshots
description: If you have a screenshot or screen recording of the issue, that will help us identify the issue.
validations:
required: false

- type: textarea
attributes:
label: Environment
description: |
- Device: [eg: Laptop, iPhone]
- OS Version: [eg: iOS 14, Windows 10]
- Browser Version: [eg: Chrome 160, Safari 17.5]
validations:
required: true
40 changes: 40 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_idea.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
name: Feature Idea
description: Suggest a feature or change to Global Bible Tools
labels:
body:
- type: checkboxes
id: terms
attributes:
label: Precheck
description: Please read through these checks before submitting an issue.
options:
- label: I have searched the issues list for similar ideas.
required: true

- type: textarea
attributes:
label: Problem
description: |
What problem are you trying to solve? (eg: I'm always frustrated when ...)
validations:
required: true

- type: textarea
attributes:
label: Solutions
description: Describe what solutions you've considered and which you prefer.
validations:
required: true

- type: dropdown
id: urgency
attributes:
label: Urgency
description: How urgent is this idea?
options:
- Urgent (No practical workaround, blocking work)
- High (Important work is made difficult without this)
- Medium (Less urgent quality of life improvements, new features to expand offerings)
- Low (An idea I want to log, but doesn't need immediate attention)
validations:
required: true
11 changes: 11 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
## Justification
<!--
Either link the PR being addressed,
or explain what problem you are trying to solve
-->

closes:

## What has changed


0 comments on commit bcbe655

Please sign in to comment.