generated from nimblehq/git-template
-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit b43dfb4
Showing
11 changed files
with
228 additions
and
0 deletions.
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,20 @@ | ||
--- | ||
name: "Bug Report" | ||
about: "You found something that is not working. Report it so that it can be fixed. 👷" | ||
title: "Fix: " | ||
labels: "type : bug" | ||
--- | ||
|
||
## Issue | ||
|
||
Describe the issue you are facing. Show us the implementation: screenshots, GIFs, etc. | ||
|
||
## Expected | ||
|
||
Describe what should be the correct behavior. | ||
|
||
## Steps to reproduce | ||
|
||
1. | ||
2. | ||
3. |
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,14 @@ | ||
--- | ||
name: "Chore" | ||
about: "Open a chore issue for a minor update." | ||
title: "Update " | ||
labels: "type : chore" | ||
--- | ||
|
||
## Why | ||
|
||
Describe the update in detail and why it is needed. | ||
|
||
## Who Benefits? | ||
|
||
Describe who will be the beneficiaries e.g. everyone, specific chapters, clients... |
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,14 @@ | ||
--- | ||
name: "Feature" | ||
about: "Open a feature issue to add new functionalities." | ||
title: "Add " | ||
labels: "type : feature" | ||
--- | ||
|
||
## Why | ||
|
||
Describe the big picture of the feature and why it is needed. | ||
|
||
## Who Benefits? | ||
|
||
Describe who will be the beneficiaries e.g. everyone, specific chapters, clients... |
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,22 @@ | ||
--- | ||
name: "Story" | ||
about: "Open a feature story" | ||
title: "[Type] As a user, I can " | ||
labels: "type : feature" | ||
--- | ||
|
||
## Why | ||
|
||
Describe the idea of the user story as in what the motive of the user story is. | ||
|
||
## Acceptance Criteria | ||
|
||
List down how the user story will be tested and what criteria are necessary for the user story to be accepted. | ||
|
||
## Design | ||
|
||
(Optional) Add design screenshots or Figma links for UI/UX-related stories. | ||
|
||
## Resources | ||
|
||
(Optional) Add useful resources such as links to documentation, implementation ideas, or best practices. |
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,13 @@ | ||
https://github.com/nimblehq/git-template/issues/?? | ||
|
||
## What happened 👀 | ||
|
||
Describe the big picture of your changes here to communicate to the team why we should accept this pull request. | ||
|
||
## Insight 📝 | ||
|
||
Describe in detail how to test the changes, which solution you tried but did not go with, referenced documentation is welcome as well. | ||
|
||
## Proof Of Work 📹 | ||
|
||
Show us the implementation: screenshots, GIFs, etc. |
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,17 @@ | ||
Link to the milestone on Github e.g. https://github.com/nimblehq/git-templates/milestone/41?closed=1 | ||
or | ||
Link to the project management tool for the release | ||
|
||
## Features | ||
|
||
Provide the ID and title of the issue in the section for each type (feature, chore and bug). The link is optional. | ||
|
||
- [ch1234] As a user, I can log in | ||
or | ||
- [[ch1234](https://github.com/nimblehq/git-templates/issues/1234)] As a user, I can log in | ||
|
||
## Chores | ||
- Same structure as in ## Feature | ||
|
||
## Bugs | ||
- Same structure as in ## Feature |
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,36 @@ | ||
*.gem | ||
*.rbc | ||
/.config | ||
/.idea | ||
/coverage/ | ||
/InstalledFiles | ||
/node_modules | ||
/pkg/ | ||
/spec/reports/ | ||
/spec/examples.txt | ||
/test/tmp/ | ||
/test/version_tmp/ | ||
/tmp/ | ||
|
||
# Used by dotenv library to load environment variables. | ||
# .env | ||
|
||
## Documentation cache and generated files: | ||
/.yardoc/ | ||
/_yardoc/ | ||
/doc/ | ||
/rdoc/ | ||
|
||
## Environment normalization: | ||
/.bundle/ | ||
/vendor/bundle | ||
/lib/bundler/man/ | ||
|
||
# for a library or gem, you might want to ignore these files since the code is | ||
# intended to run in multiple environments; otherwise, check them in: | ||
# Gemfile.lock | ||
# .ruby-version | ||
# .ruby-gemset | ||
|
||
# unless supporting rvm < 1.11.0 or doing something fancy, ignore this: | ||
.rvmrc |
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 @@ | ||
{COPY THE TASK URL HERE} | ||
|
||
## What happened 👀 | ||
|
||
Describe the big picture of your changes here to communicate to the team why we should accept this pull request. | ||
|
||
## Insight 📝 | ||
|
||
Describe in detail how to test the changes, which solution you tried but did not go with, referenced documentation is welcome as well. | ||
|
||
## Proof Of Work 📹 | ||
|
||
Show us the implementation: screenshots, GIFs, etc. | ||
|
||
## Reviewers ✅ | ||
|
||
Mention the reviewers here once the merge request is ready for review. | ||
|
||
<!-- Base labels. --> | ||
/label ~"status : wip" |
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,22 @@ | ||
## Features | ||
|
||
Provide the ID and title of each issue in the section for each type (feature, chore and bug). The link is optional. | ||
|
||
- [{ISSUE ID}] {ISSUE TITLE} | ||
or | ||
- [[{ISSUE ID}]]({ISSUE LINK})] {ISSUE TITLE} | ||
|
||
## Chores | ||
|
||
- Same structure as in ## Feature | ||
|
||
## Bugs | ||
|
||
- Same structure as in ## Feature | ||
|
||
## Reviewers ✅ | ||
|
||
Mention the reviewers here once the merge request is ready for review. | ||
|
||
<!-- Base labels. --> | ||
/label ~"type : release" |
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,19 @@ | ||
Copyright (c) 2014 and onwards Nimble. | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in | ||
all copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
THE SOFTWARE. |
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,31 @@ | ||
# Git Repository Template | ||
|
||
Project repository template to set up all public projects at [Nimble](https://nimblehq.co/) | ||
|
||
## Usage | ||
|
||
Clone the repository | ||
|
||
`git clone [email protected]:nimblehq/git-template.git` | ||
|
||
## License | ||
|
||
This project is Copyright (c) 2014 and onwards Nimble. It is free software and may be redistributed under the terms specified in the [LICENSE] file. | ||
|
||
[LICENSE]: /LICENSE | ||
|
||
## About | ||
<a href="https://nimblehq.co/"> | ||
<picture> | ||
<source media="(prefers-color-scheme: dark)" srcset="https://assets.nimblehq.co/logo/dark/logo-dark-text-160.png"> | ||
<img alt="Nimble logo" src="https://assets.nimblehq.co/logo/light/logo-light-text-160.png"> | ||
</picture> | ||
</a> | ||
|
||
This project is maintained and funded by Nimble. | ||
|
||
We love open source and do our part in sharing our work with the community! | ||
See [our other projects][community] or [hire our team][hire] to help build your product. | ||
|
||
[community]: https://github.com/nimblehq | ||
[hire]: https://nimblehq.co/ |