-
Notifications
You must be signed in to change notification settings - Fork 0
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: issue templates and contributing guidelines #143
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
--- | ||
name: "\U0001F41B Bug report" | ||
about: Create a report to help us improve | ||
title: '' | ||
labels: bug | ||
assignees: '' | ||
|
||
--- | ||
|
||
**Describe the bug** | ||
A clear and concise description of what the bug is. | ||
|
||
**To Reproduce** | ||
Steps to reproduce the behavior: | ||
1. Go to '...' | ||
2. Click on '....' | ||
3. Scroll down to '....' | ||
4. See error | ||
|
||
**Expected behavior** | ||
A clear and concise description of what you expected to happen. | ||
|
||
**Screenshots** | ||
If applicable, add screenshots to help explain your problem. | ||
|
||
**Smartphone (please complete the following information):** | ||
- GRUP version: [e.g. 1.6.1] | ||
- Device: [e.g. iPhone6] | ||
- OS: [e.g. iOS8.1] | ||
- (if web) Browser: [e.g. Safari, Chrome] | ||
|
||
**Additional context** | ||
Add any other context about the problem here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
--- | ||
name: "\U0001F9D1\U0001F4BB Feature request" | ||
about: Suggest an idea for this project | ||
title: '' | ||
labels: enhancement | ||
assignees: '' | ||
|
||
--- | ||
|
||
**Is your feature request related to a problem? Please describe.** | ||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | ||
|
||
**Describe the solution you'd like** | ||
A clear and concise description of what you want to happen. | ||
|
||
**Describe alternatives you've considered** | ||
A clear and concise description of any alternative solutions or features you've considered. | ||
|
||
**Additional context** | ||
Add any other context or screenshots about the feature request here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
# Contributing | ||
|
||
Hey there! Thanks for thinking about contributing to GRUP! We appreciate all kinds of help, whether it's fixing bugs, adding new features, or improving our documentation. | ||
|
||
This guide will help you get started. | ||
|
||
## Got ideas or questions? | ||
|
||
Check out our [discussions](https://github.com/gruprsvp/grup/discussions). If you don't see a topic that matches your idea or question, feel free to start a new one! | ||
|
||
## Reporting Issues | ||
|
||
Found a bug? Please let us know by [submitting an issue](https://github.com/gruprsvp/grup/issues/new). Your feedback helps us improve! | ||
|
||
## Development | ||
|
||
Before diving into a new feature, please start a discussion to share your idea. We love to hear what you're thinking! | ||
|
||
If you're new to the project, issues labeled with [good first issue](https://github.com/gruprsvp/grup/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) are a great place to start. | ||
|
||
### Setting up your development environment | ||
|
||
1. Fork the repository and clone your fork. | ||
2. Make sure you have these tools installed: | ||
- Flutter[^flutter-get-started] | ||
- Supabase CLI[^supabase-cli] | ||
- Docker or another compatible runtime | ||
3. Ensure Docker is running. | ||
4. From the root of the project, start the Supabase server: | ||
```sh | ||
supabase start | ||
``` | ||
5. Export the Supabase URL and API key (you only need to do this once): | ||
```sh | ||
supabase status -o json > supabase/config/localhost.json | ||
``` | ||
6. Update the app configuration in `lib/main.dart` (`supabaseConfigFile`) to point to your local setup. | ||
7. While making changes, run `build_runner` in watch mode for code generation: | ||
```sh | ||
dart run build_runner watch --delete-conflicting-outputs | ||
``` | ||
8. Run tests to make sure everything is working: | ||
```sh | ||
flutter test | ||
``` | ||
|
||
### Submitting a Pull Request | ||
|
||
1. Create a new branch from `main` for your feature or bugfix. | ||
2. Make your changes. | ||
3. Ensure all tests pass. | ||
4. Commit your changes with a descriptive commit message. | ||
5. Push your branch to your fork. | ||
6. Open a pull request against the `main` branch of the original repository. | ||
7. Clearly describe the problem and solution in your pull request. Include the issue number if applicable. | ||
8. Wait for a review and address any feedback. | ||
|
||
[^flutter-get-started]: https://docs.flutter.dev/get-started/install | ||
[^supabase-cli]: https://supabase.com/docs/guides/cli/getting-started |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe we should clean up tomorrow the backlog + milestones