PR: Create Git templates #163
Conversation
Add feature_request.md: - template for submitting new features to the GitHub project
nverbic
requested review from
dricazenck,
othetgyi,
rajashreemunoli,
nora-weisser,
goelsonali,
lilrafil and
nimat1
project-templates/feature_request.md
Outdated
There was a problem hiding this comment.
Please leave your suggestions and ideas.
There was a problem hiding this comment.
Please have a look under the website templates: https://github.com/Women-Coding-Community/WomenCodingCommunity.github.io/tree/main/.github here is where we should create the templates
There was a problem hiding this comment.
@dricazenck This is the other repository, is it ok?
I thought we wanted to add to this one https://github.com/Women-Coding-Community/wcc-backend/tree/main/.github - but I have no premissions to update the Settings.
There was a problem hiding this comment.
Great job on creating this template! 👏 I've reviewed it and left a few comments for your consideration. Feel free to apply or decline them based on your judgment.
Also, this template should be created under .github in separate folder called ISSUE_TEMPLATE, so it can be applied automatically when you create an issue in the repo.
project-templates/feature_request.md
Outdated
|
|
||
| ### Title | ||
|
|
||
| *Example: Create Members GET API* |
There was a problem hiding this comment.
Do we need to duplicate the title in the description? The title will be automatically populated with the "feat: " as you put on 4th line of the doc.
There was a problem hiding this comment.
Yes, less is more - I will remove this line.
project-templates/feature_request.md
Outdated
|
|
||
| ### Description | ||
|
|
||
| Description of the new feature and the problem it is solving. |
There was a problem hiding this comment.
Just a suggestion (with more explanation of what to expect in this part).
Provide description of a new feature. Include:
- How it should work.
- Any specific requirements or edge cases.
- Mockups or examples, if applicable.
And I like the example 👍
project-templates/feature_request.md
Outdated
| *Example: When Client use GET to access members resources that are located at the specified URL on | ||
| the | ||
| server the server will respond with the list of members and all its data.* |
There was a problem hiding this comment.
| *Example: When Client use GET to access members resources that are located at the specified URL on | |
| the | |
| server the server will respond with the list of members and all its data.* | |
| *Example: When Client use GET to access members resources that are located at the specified URL on the server the server will respond with the list of members and all its data.* |
should it be formatted like this?
project-templates/feature_request.md
Outdated
| the | ||
| server the server will respond with the list of members and all its data.* | ||
|
|
||
| ### Solution |
There was a problem hiding this comment.
| ### Solution | |
| ### Possible Solution |
project-templates/feature_request.md
Outdated
|
|
||
| Describe the solution | ||
|
|
||
| *Ex: Use the Controller-Service-Repository pattern from Spring Boot applications. The Controller is |
There was a problem hiding this comment.
| *Ex: Use the Controller-Service-Repository pattern from Spring Boot applications. The Controller is | |
| *Example: Use the Controller-Service-Repository pattern from Spring Boot applications. The Controller is |
project-templates/feature_request.md
Outdated
| ### Screenhoots | ||
|
|
||
| Add screenshots |
There was a problem hiding this comment.
| ### Screenhoots | |
| Add screenshots | |
| ### Additional Context | |
| Include any other context, logs, or screenshots that might help explain your request. |
Add PR suggestions
Add bug_report.md: - bug_report from the community's repository (link)
Add PULL_REQUEST_TEMPLATE.md: - use existing from the community's repository (link) - add example Add CONTRIBUTING.md - use existing from the community's repository (link) - update link references to wcc-backend repository
|
There was a problem hiding this comment.
File is same as the file here
I have updated some references to wcc-backend repository.
Maybe we can remove or update some descriptios in this file. I would remove this section:
Alternatively, Git CLI way to Sync forked repository with origin repository
and leave section:
Additional way to Sync forked repository with origin repository using Git CLI:
Closes #123
Add feature_request.md:
TODO: