Skip to content

Commit 6a7eac4

Browse files
committed
feat(init): initial commit
0 parents  commit 6a7eac4

14 files changed

Lines changed: 10916 additions & 0 deletions

.github/CODEOWNERS

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
#All Files/PRS
2+
* @pocket/backend

.github/workflows/linter.yml

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
---
2+
###########################
3+
###########################
4+
## Linter GitHub Actions ##
5+
###########################
6+
###########################
7+
name: Lint Code Base
8+
9+
#
10+
# Documentation:
11+
# https://help.github.com/en/articles/workflow-syntax-for-github-actions
12+
#
13+
14+
#############################
15+
# Start the job on all pull requests #
16+
#############################
17+
on:
18+
# Run on every pull request created or updated
19+
# https://docs.github.com/en/actions/learn-github-actions/events-that-trigger-workflows#pull_request
20+
pull_request:
21+
22+
###############
23+
# Set the Job #
24+
###############
25+
jobs:
26+
build:
27+
# Name the Job
28+
name: Lint Code Base
29+
# Set the agent to run on
30+
runs-on: ubuntu-latest
31+
32+
##################
33+
# Load all steps #
34+
##################
35+
steps:
36+
##########################
37+
# Checkout the code base #
38+
##########################
39+
- name: Checkout Code
40+
uses: actions/checkout@v2
41+
42+
##########################
43+
# Github Super Linter needs
44+
# the latest definitions installed
45+
##########################
46+
- name: Use Node.js 16.x
47+
uses: actions/setup-node@v3
48+
with:
49+
node-version: 16.x
50+
# Install our eslint packages.
51+
# We may have custom tsconfigs, eslints that are brought in via a package.
52+
- run: npm install
53+
54+
################################
55+
# Run Linter against code base #
56+
################################
57+
- name: Lint Code Base
58+
59+
# We use the Github super linter, it can be cranky at times, so in that moment here are the docs https://github.com/github/super-linter
60+
uses: docker://ghcr.io/github/super-linter:slim-v4
61+
62+
# All Environment variables are defined here https://github.com/github/super-linter#environment-variables
63+
env:
64+
# The name of the repository default branch.
65+
DEFAULT_BRANCH: main
66+
67+
# Directory for all linter configuration rules.
68+
# This is the root of our codebase.
69+
LINTER_RULES_PATH: /
70+
71+
# Will parse the entire repository and find all files to validate across all types.
72+
# NOTE: When set to false, only new or edited files will be parsed for validation.
73+
VALIDATE_ALL_CODEBASE: true
74+
75+
# Filename for ESLint configuration (ex: .eslintrc.yml, .eslintrc.json)
76+
TYPESCRIPT_ES_CONFIG_FILE: .eslintrc.js
77+
78+
#####
79+
# Note: All the VALIDATE[LANGUAGE] variables behave in a specific way.
80+
# If none of them are passed, then they all default to true.
81+
# However if any one of the variables are set, we default to leaving any unset variable to false.
82+
# This means that if you run the linter “out of the box”, all languages will be checked.
83+
# But if you wish to select specific linters, we give you full control to choose which linters are run, and won’t run anything unexpected.
84+
####
85+
86+
# Flag to enable or disable the linting process of the JavaScript language. (Utilizing: eslint)
87+
# Will validate any raw *.js in the repo like a jest.config.js
88+
VALIDATE_JAVASCRIPT_ES: true
89+
90+
# Flag to enable or disable the linting process of the TypeScript language. (Utilizing: eslint)
91+
VALIDATE_TYPESCRIPT_ES: true
92+
93+
# Flag to enable or disable the linting process of the YAML language.
94+
# Note - disabled as of 26 Jan, 2022
95+
# VALIDATE_YAML: true

.github/workflows/publish.yml

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
name: Node.js Package
2+
3+
on:
4+
pull_request:
5+
branches:
6+
- main
7+
push:
8+
branches:
9+
- main
10+
11+
jobs:
12+
validator:
13+
runs-on: ubuntu-latest
14+
steps:
15+
- uses: actions/checkout@v2
16+
- uses: RoadieHQ/backstage-entity-validator@v0.3.2
17+
with:
18+
path: 'catalog-info.yaml'
19+
20+
build:
21+
runs-on: ubuntu-latest
22+
steps:
23+
- uses: actions/checkout@v2
24+
- uses: actions/setup-node@v2.4.1
25+
with:
26+
node-version: '16.x'
27+
registry-url: 'https://registry.npmjs.org'
28+
scope: '@pocket-tools'
29+
- run: npm ci
30+
- name: Semantic Release
31+
uses: cycjimmy/semantic-release-action@v2
32+
env:
33+
GITHUB_TOKEN: ${{ secrets.CI_GITHUB_TOKEN }}
34+
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
35+
NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}

.gitignore

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
.idea
2+
3+
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
4+
5+
# dependencies
6+
/node_modules
7+
8+
9+
# misc
10+
.DS_Store
11+
12+
npm-debug.log*

.nvmrc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
16

CODE_OF_CONDUCT.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Community Participation Guidelines
2+
3+
This repository is governed by Mozilla's code of conduct and etiquette guidelines.
4+
For more details, please read the
5+
[Mozilla Community Participation Guidelines](https://www.mozilla.org/about/governance/policies/participation/).
6+
7+
## How to Report
8+
For more information on how to report violations of the Community Participation Guidelines, please read our '[How to Report](https://www.mozilla.org/about/governance/policies/participation/reporting/)' page.

CONTRIBUTING.md

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
## Contributing
2+
3+
Thank you for checking out our Pocket TSConfig work. We welcome contributions from everyone! By participating in this project, you agree to abide by the Mozilla [Community Participation Guidelines](https://www.mozilla.org/about/governance/policies/participation/).
4+
5+
### Asking questions / receiving updates
6+
7+
* Slack channel (Mozilla staff only): #team-backend
8+
9+
* File issues/questions on Github: [https://github.com/Pocket/tsconfig/issues](https://github.com/Pocket/tsconfig/issues). We typically triage new issues every Monday.
10+
11+
### Finding Bugs & Filing Tickets
12+
13+
If you've found a bug, or have a feature idea that you you'd like to see, follow these simple guidelines:
14+
15+
* Pick a thoughtful and concise title for the issue (ie. *not* Thing Doesn't Work!)
16+
17+
* If you can reproduce the bug, give a step-by-step recipe
18+
19+
* Include stack traces from the console(s) where appropriate
20+
21+
* Screenshots and screen recordings welcome!
22+
23+
* When in doubt, take a look at some existing issues and emulate
24+
25+
### Contributing Code
26+
27+
If you are new to the repo, you might want to pay close attention to these tags, as they are typically a great way to get started: Good First Bug, Bug, Chore, and Polish. If you see a bug that is not yet assigned to anyone, start a conversation with an engineer in the ticket itself, expressing your interest in taking the bug. If you take the bug, someone will set the ticket to Assigned to Contributor, so we can be proactive about helping you succeed in fixing the bug.
28+
29+
When you have some code written, you can open up a Pull Request, get your code reviewed, and see your code merged into the codebase.
30+
31+
### Creating Pull Requests
32+
33+
You have identified the bug, written code and now want to get it into the main repo using a [Pull Request](https://help.github.com/articles/about-pull-requests/).
34+
35+
All code is added using a pull request against the main branch of our repo. Before submitting a PR, please go through this checklist:
36+
37+
* Fill out the pull request template as outlined
38+
39+
* Make sure your PR will merge gracefully with the main branch at the time you create the PR, and that your commit history is 'clean'
40+
41+
### Understanding Code Reviews
42+
43+
You have created a PR and submitted it to the repo, and now are waiting patiently for you code review feedback. One of the projects module owners will be along and will either:
44+
45+
* Make suggestions for some improvements
46+
47+
* Give you a thumbs up in the comments section, indicating the review is done and the code can be merged
48+
49+
Typically, you will iterate on the PR, making changes and pushing your changes to new commits on the PR. When the reviewer is satisfied that your code is good-to-go, you will get the coveted R+ comment, and your code can be merged. If you have commit permission, you can go ahead and merge the code to master, otherwise, it will be done for you.
50+
51+
Our project prides itself on its respectful, patient and positive attitude when it comes to reviewing contributors' code, and as such, we expect contributors to be respectful, patient and positive in their communications as well.
52+
53+
### Writing Good Git Commit Messages
54+
55+
We like this overview by Chris Beams on "[How to Write a Git Commit Message](https://chris.beams.io/posts/git-commit/)".
56+
57+
The tl;dr is:
58+
59+
1. [Separate subject from body with a blank line](https://chris.beams.io/posts/git-commit/#separate)
60+
61+
2. [Limit the subject line to 50 characters](https://chris.beams.io/posts/git-commit/#limit-50)
62+
63+
3. [Capitalize the subject line](https://chris.beams.io/posts/git-commit/#capitalize)
64+
65+
4. [Do not end the subject line with a period](https://chris.beams.io/posts/git-commit/#end)
66+
67+
5. [Use a verb to start your subject line (Add, Remove, Fix, Update, Rework, Polish, etc.)](https://chris.beams.io/posts/git-commit/#imperative)
68+
69+
6. [Wrap the body at 72 characters](https://chris.beams.io/posts/git-commit/#wrap-72)
70+
71+
7. [Use the body to explain *what* and *why* vs. *how*](https://chris.beams.io/posts/git-commit/#why-not-how)

0 commit comments

Comments
 (0)