-
Notifications
You must be signed in to change notification settings - Fork 32
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
Add templates for issues and PR #774
Merged
Merged
Changes from all commits
Commits
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,49 @@ | ||
--- | ||
name: Bug report | ||
about: Create a report to help us improve GeoNetwork-UI | ||
title: '' | ||
labels: 'bug' | ||
assignees: '' | ||
--- | ||
|
||
### Describe the bug | ||
|
||
When opening the application [...] | ||
|
||
<!-- | ||
Please provide an in-depth description of the problem witnessed and in which context it happens, as well as the expected result. | ||
--> | ||
|
||
- GeoNetwork-UI version used: [`X.X.X` or `main`] | ||
|
||
- Application: [...] | ||
|
||
<!-- | ||
Ideally, these steps should be reproducible with the local docker composition in `support-services`. If not, please provide a link to an online platform from which the problem can be investigated. | ||
--> | ||
|
||
### Expected behaviour | ||
|
||
The application should [...] | ||
|
||
<!-- | ||
Please describe here the expected behavior of the application | ||
--> | ||
|
||
### Steps To Reproduce | ||
|
||
- Run [...] | ||
- Open [...] | ||
- Click on [...] | ||
|
||
<!-- | ||
Ideally, these steps should be reproducible with the local docker composition in `support-services`. If not, please provide a link to an online platform from which the problem can be investigated. | ||
--> | ||
|
||
### Screenshots | ||
|
||
[...] | ||
|
||
<!-- | ||
Please add screenshots showing the unexpected visual result, or even better an animated screen capture. | ||
--> |
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: Feature request | ||
about: Suggest an idea or request a feature for this project | ||
title: '' | ||
labels: 'feature request' | ||
assignees: | ||
--- | ||
|
||
### Description | ||
|
||
I would like to request adding [...] | ||
|
||
<!-- | ||
Please describe here what you think constitute a valuable improvement to the project. | ||
--> | ||
|
||
### Motivation | ||
|
||
This request stems from the fact that [...] | ||
|
||
<!-- | ||
Please describe here the underlying motivation from this request/suggestion: a recurring complaint from users, a technical limitation, bad performance, etc. | ||
|
||
Also please keep in mind that writing a request does _not_ mean it will get implemented automatically! The best way to see an improvement happen is to secure funding for it, or to contribute it directly. | ||
--> | ||
|
||
### Inspiration and context | ||
|
||
This request takes inspiration from [...] | ||
|
||
<!-- | ||
Share here any link/image that might help other people understand the intended outcome, as well as more information about the context this request might have emerged from. | ||
--> |
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,57 @@ | ||
--- | ||
name: Proposal | ||
about: Describe a feature or tech task that you intend to push forward | ||
title: '' | ||
labels: 'enhancement' | ||
assignees: '' | ||
--- | ||
|
||
### Description of the proposal | ||
|
||
This proposal aims at adding [...] | ||
|
||
The final outcome will be [...] | ||
|
||
<!-- | ||
Proposals can either be of technical or functional nature. Please describe the intended outcome clearly as to better communicate your intention. | ||
--> | ||
|
||
### Motivation | ||
|
||
This proposal stems from the fact that [...] | ||
|
||
<!-- | ||
Optionally, please describe here the underlying motivation from this proposal: a recurring complaint from users, a technical limitation, bad performance, etc. | ||
--> | ||
|
||
### Scope | ||
|
||
This proposal affects [...] | ||
|
||
<!-- | ||
A proposal scope can either be an application, a specific page or component, a module, a dependency... | ||
--> | ||
|
||
### Possible alternatives | ||
|
||
Another way of achieving this could be to [...] | ||
|
||
<!-- | ||
It is always good to provide alternatives in case the main proposal does not gather a high enough approval | ||
--> | ||
|
||
### Inspiration and context | ||
|
||
This proposal takes inspiration from [...] | ||
|
||
<!-- | ||
Share here any link/image that might help other people understand the intended outcome, as well as more information about the context this proposal might have emerged from. | ||
--> | ||
|
||
--- | ||
|
||
<!-- | ||
Please give credit to the sponsor of this work if possible. If this work is not funded yet, please let it be known clearly!! | ||
--> | ||
|
||
**This work is sponsored by [Organization ABC](xx)**. |
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,45 @@ | ||
### Description | ||
|
||
This PR introduces [...] | ||
|
||
<!-- | ||
Describe here the changes brought by this PR. Do not forget to link any relevant issue or discussion to help people review your work! | ||
--> | ||
|
||
### Architectural changes | ||
|
||
The following library now depends on [...] | ||
|
||
<!-- | ||
Describe here any changes to the project architecture: adding/removing modules or libraries, changing dependencies between libraries and apps, changes to external NPM dependencies... | ||
--> | ||
|
||
### Screenshots | ||
|
||
[...] | ||
|
||
<!-- | ||
If the changes incur visual changes, please include screenshots or an animated screen capture. | ||
--> | ||
|
||
### Quality Assurance Checklist | ||
|
||
- [ ] Commit history is devoid of any _merge commits_ and readable to facilitate reviews | ||
- [ ] If **new logic** ⚙️ is introduced: unit tests were added | ||
- [ ] If **new user stories** 🤏 are introduced: E2E tests were added | ||
- [ ] If **new UI components** 🕹️ are introduced: corresponding stories in Storybook were created | ||
- [ ] If **breaking changes** 🪚 are introduced: add the `breaking change` label | ||
- [ ] If **bugs** 🐞 are fixed: add the `backport <release branch>` label | ||
- [ ] The [documentation website](docs) 📚 has received the love it deserves | ||
|
||
<!-- | ||
Please only check items relevant to your contribution. Thank you very much for your time and efforts! | ||
--> | ||
|
||
--- | ||
|
||
<!-- | ||
Please give credit to the sponsor of this work if possible. | ||
--> | ||
|
||
**This work is sponsored by [Organization ABC](xx)**. |
Oops, something went wrong.
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.
What would be the lifecycle of this kind of request ?
Like any development would need funding.
It's not clear if someone wants to add a feature, or expect us to implement his feature.
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.
It's not supposed to be for request, but for proposal. It says "a feature or task that you intend to push forward".
Basically this is meant for people that have the funding/time to implement something and want to get approval from the project.
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.
I added a separate
proposal.md
template for proposals with funding, and thefeature_request
template is now for requests/suggestions but without actual funding/intention to contribute.