Skip to content
Merged
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
79 changes: 79 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
name: Bug Report
description: Report a problem or unexpected behavior in Orbit
title: "[Bug]: "
labels:
- bug
body:
- type: markdown
attributes:
value: |
Thanks for reporting a bug!

Please make sure you are using the latest version and have checked existing issues first.

- type: textarea
id: description
attributes:
label: Description
description: Describe the issue and what happened.
placeholder: Explain what went wrong.
validations:
required: true

- type: textarea
id: expected
attributes:
label: Expected Behavior
description: What should have happened instead?
validations:
required: true

- type: textarea
id: reproduce
attributes:
label: Steps To Reproduce
description: Provide steps someone else can follow to reproduce this.
placeholder: |
1. Start Orbit
2. Open...
3. Click...
4. Observe...
validations:
required: true

- type: input
id: version
attributes:
label: Orbit Version
placeholder: "Example: v3.0.0"
validations:
required: true

- type: dropdown
id: deployment
attributes:
label: Deployment Type
options:
- Self-hosted
- Development environment
- Other
validations:
required: true

- type: textarea
id: environment
attributes:
label: Environment
description: Include OS, architecture, Node/Bun version, database, and other relevant details.
placeholder: |
OS:
Architecture:
Bun version:
Database:

- type: textarea
id: logs
attributes:
label: Logs
description: Include relevant logs or errors.
render: shell
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: Orbit Documentation
url: https://docs.planetaryapp.us/
about: Read the documentation before opening an issue.
- name: Orbit Discord
url: https://discord.gg/M3CX76KQsK
about: Ask questions and get community help.
51 changes: 51 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
name: Feature Request
description: Suggest an improvement or new feature for Orbit
title: "[Feature]: "
labels:
- enhancement
body:
- type: markdown
attributes:
value: |
Thanks for suggesting an improvement!

Large features may require an RFC before implementation.

- type: textarea
id: problem
attributes:
label: Problem
description: What problem would this feature solve?
placeholder: Explain the use case.
validations:
required: true

- type: textarea
id: solution
attributes:
label: Proposed Solution
description: Describe what you would like Orbit to do.
validations:
required: true

- type: textarea
id: alternatives
attributes:
label: Alternatives
description: Are there existing workarounds or other solutions?

- type: textarea
id: impact
attributes:
label: User Impact
description: Who would benefit from this feature and why?

- type: checkboxes
id: checks
attributes:
label: Checklist
options:
- label: I have checked that this feature does not already exist.
required: true
- label: I have searched existing issues for similar requests.
required: true
59 changes: 59 additions & 0 deletions .github/ISSUE_TEMPLATE/rfc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
name: RFC Proposal
description: Propose a major feature or architectural change
title: "[RFC]: "
labels:
- rfc
body:
- type: markdown
attributes:
value: |
RFCs are for major changes that require community and maintainer feedback before implementation.

Examples:
- New major systems
- Large features
- Architecture changes
- Database redesigns
- Replacing major dependencies

- type: textarea
id: summary
attributes:
label: Summary
description: Describe the proposed change.
validations:
required: true

- type: textarea
id: problem
attributes:
label: Problem
description: What problem does this solve?
validations:
required: true

- type: textarea
id: design
attributes:
label: Proposed Design
description: Explain how this should work.
validations:
required: true

- type: textarea
id: alternatives
attributes:
label: Alternatives Considered
description: What other approaches were considered?

- type: textarea
id: impact
attributes:
label: Impact
description: Explain user, developer, and compatibility impact.

- type: textarea
id: questions
attributes:
label: Open Questions
description: What feedback do you need from contributors?
55 changes: 55 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/feature.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# Pull Request

Thank you for contributing to Orbit! 🐈

Before submitting, please make sure you have read the [Contributing Guide](https://github.com/PlanetaryOrbit/orbit/blob/main/CONTRIBUTING.md).

## Description

<!--
Describe what this PR changes and why.
-->

## Related Issues

<!--
Examples:
Closes #123
Fixes #123
Related to #123
-->

## Type of Change

- [ ] Bug fix
- [ ] New feature
- [ ] Enhancement
- [ ] Documentation
- [ ] Refactor
- [ ] Performance improvement
- [ ] Dependency update
- [ ] Other

## Testing

Describe how you tested your changes.

- [ ] Tested locally
- [ ] Tested using Docker
- [ ] Tested database changes (if applicable)

## Screenshots / Videos

<!-- Required for UI changes -->

## Checklist

- [ ] I have read the contributing guidelines.
- [ ] My changes follow the project's style guidelines.
- [ ] I have tested my changes.
- [ ] I have updated documentation if needed.
- [ ] This PR does not contain unrelated changes.

## Additional Notes

<!-- Anything maintainers should know -->
74 changes: 74 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/rfc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
# RFC: <Title>

Thank you for proposing a change to Orbit.

RFCs are required for major features, large architectural changes, and changes that significantly affect users or maintainers.

## Summary

<!--
A short explanation of what this RFC proposes.
-->

## Problem

<!--
What problem does this solve?
Why is this change needed?
-->

## Proposed Solution

<!--
Describe the proposed implementation or design.
-->

## Alternatives Considered

<!--
What other approaches were considered?
Why were they rejected?
-->

## Impact

### Users

<!--
How does this affect Orbit users?
-->

### Developers

<!--
How does this affect contributors and maintainers?
-->

### Compatibility

<!--
Does this introduce breaking changes?
Does it require migrations?
-->

## Implementation Plan

<!--
Describe the planned steps.
-->

1.
2.
3.

## Open Questions

<!--
Questions that need community or maintainer feedback.
-->

## Additional Notes

<!--
Anything else relevant.
-->
10 changes: 10 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Orbit Pull Request

Please select the appropriate pull request template:

- [Normal Pull Request](?expand=1&template=feature.md)
- [RFC Pull Request](?expand=1&template=rfc.md)

If you are unsure which template to use, please read the [Contributing Guide](https://github.com/PlanetaryOrbit/orbit/blob/main/CONTRIBUTING.md).

After selecting a template, go to the **Preview** tab and click the link above.
Loading
Loading