-
Notifications
You must be signed in to change notification settings - Fork 17
update custom issue template backend tickets #1015
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
Open
kenslachtajr
wants to merge
2
commits into
main
Choose a base branch
from
feat/custom-issue-template-backend-tickets-update
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+56
−28
Open
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 hidden or 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
This file contains hidden or 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
10 changes: 10 additions & 0 deletions
10
.github/custom-issue-template/backend-kit/4. Final checks.md
This file contains hidden or 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,10 @@ | ||
# Background | ||
|
||
There are a few final details that need to be in place for each backend kit. | ||
|
||
# Acceptance | ||
|
||
- [ ] Typescript - kit uses the latest version of TypeScript | ||
- [ ] .nvmrc - A .nvmrc file should be provided with the kit to specify the node version used to ensure users are using the targeted node version | ||
- [ ] No lock files - the lockfile from the project should be excluded to allow users to utilize their package manager of choice | ||
- [ ] Pinned dependency versions - because the lockfile is excluded, kits should pin their dependency version numbers to a fixed value |
61 changes: 33 additions & 28 deletions
61
.github/custom-issue-template/frontend-kit/3. Update the readme.md
This file contains hidden or 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 |
---|---|---|
@@ -1,82 +1,87 @@ | ||
# Background | ||
|
||
The kit should include a thorough README with all architectural decisions the user should be aware of when utilizing it. It shouldn't rewrite docs for existing libraries but any key decisions should be documented. This is what will be visible to users on the website when they look at the details page. | ||
|
||
# Acceptance | ||
|
||
- [ ] Update the below template with relevant information for users who want to utilize this kit with appropriate instructions. | ||
|
||
# Template | ||
|
||
> # <kit name> starter kit | ||
> | ||
> | ||
> This starter kit features <technology list>. | ||
> | ||
> | ||
> ## Table of Contents | ||
> | ||
> | ||
> - [Overview](#overview) | ||
> - [Tech Stack](#tech-stack) | ||
> - [Included Tooling](#included-tooling) | ||
> - [Example Components](#example-components) | ||
|
||
- [Architectural Decisions](#architectural-decisions) | ||
|
||
> - [Example Components](#example-components) | ||
> - [Installation](#installation) | ||
> - [CLI](#cli) | ||
> - [Manual](#manual) | ||
> - [Commands](#commands) | ||
> - [Demo Implementation](#demo-implementation) | ||
> | ||
> | ||
> ## Overview | ||
> | ||
> | ||
> ### Tech Stack | ||
> | ||
> | ||
> - List of technologies used with links to relevant doc pages | ||
> | ||
> | ||
> ### Included Tooling | ||
> | ||
> | ||
> - List of tooling used, e.g. jest, Storybook, ESLint, Prettier, etc., with their relevant doc pages linked | ||
> - [Jest](https://jestjs.io/) - Test runner | ||
> - [TypeScript](https://www.typescriptlang.org/) - Type checking | ||
> - [Storybook](https://storybook.js.org/) - Component library | ||
> - [ESLint](https://eslint.org/) - Code linting | ||
> - [Prettier](https://prettier.io/) - Code formatting | ||
> | ||
> | ||
> ### Architectural Decisions | ||
> | ||
> | ||
> List all important architectural decisions here and patterns users should be aware of. | ||
> | ||
> | ||
> ### Example Components | ||
> | ||
> In this `starters/<kit path>/src` directory you will find the <Component Names> directories. | ||
> | ||
> | ||
> In this `starters/<kit path>/src` directory you will find the <Component Names> directories. | ||
> | ||
> <explain each components structure with relation to the architectural decisions outlined> | ||
> | ||
> | ||
> ## Installation | ||
> | ||
> | ||
> ### CLI (Recommended) | ||
> | ||
> | ||
> ```bash | ||
> npx create-starter-dev | ||
> ``` | ||
> | ||
> | ||
> - Follow the prompts to select the <kit name> starter kit and name your new project. | ||
> - `cd` into your project directory and run `npm install`. | ||
> - Run `npm run dev` to start the development server. | ||
> - Open your browser to `http://localhost:3000` to see the included example code running. | ||
> | ||
> | ||
> ### Manual | ||
> | ||
> | ||
> ```bash | ||
> git clone https://github.com/thisdot/starter.dev.git | ||
> ``` | ||
> | ||
> | ||
> - Copy and rename the `starters/<kit name>` directory to the name of your new project. | ||
> - `cd` into your project directory and run `npm install`. | ||
> - Run `npm run dev` to start the development server. | ||
> - Open your browser to `http://localhost:3000` to see the included example code running. | ||
> | ||
> | ||
> ## Commands | ||
> | ||
> | ||
> - List of helpful package.json scripts and their purpose | ||
> | ||
> | ||
> ## Demo Implementation | ||
> | ||
> | ||
> [Repository](https://github.com/thisdot/starter.dev-showcases/tree/main/<kit name>) | ||
> | ||
> The demo application re-implements some of GitHub's pages and functionality. It uses the OAuth credentials in GitHub to authenticate users with their GitHub accounts and uses RxJS to fetch data from the GitHub API. Check out the link above to learn more or check out the demo! | ||
> | ||
> The demo application re-implements some of GitHub's pages and functionality. It uses the OAuth credentials in GitHub to authenticate users with their GitHub accounts and uses RxJS to fetch data from the GitHub API. Check out the link above to learn more or check out the demo! |
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.
same comment as the FE ticket changes. i think this is too strict.
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.
These are taken directly from the Specification. If we want to make this less strict, we should probably visit this in the Specification.