Skip to content

Commit 39a27ec

Browse files
raaeraae
committed
Initial commit
0 parents  commit 39a27ec

23 files changed

+12192
-0
lines changed

‎.github/workflows/release.yml

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: CI
2+
on: push
3+
jobs:
4+
release:
5+
name: Release
6+
runs-on: ubuntu-latest
7+
steps:
8+
- name: Checkout
9+
uses: actions/checkout@v2
10+
with:
11+
fetch-depth: 0
12+
- name: Setup Node.js
13+
uses: actions/setup-node@v2
14+
with:
15+
node-version: "lts/*"
16+
- name: Install dependencies
17+
run: yarn install
18+
- name: Release
19+
env:
20+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
21+
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
22+
run: npx semantic-release

‎.gitignore

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Dependency directories
2+
node_modules/
3+
4+
# Logs
5+
logs
6+
*.log
7+
npm-debug.log*
8+
yarn-debug.log*
9+
yarn-error.log*
10+
11+
# Yarn (not npm)
12+
package-lock.json
13+
14+
# Gatsby cache and public
15+
.cache
16+
public/
17+
18+
# README copied over when releasing
19+
plugin/README.md

‎.husky/.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
_

‎.husky/pre-commit

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
#!/bin/sh
2+
. "$(dirname "$0")/_/husky.sh"
3+
4+
npx lint-staged

‎.prettierrc

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{}

‎.releaserc

+53
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
{
2+
"branches": [
3+
"main",
4+
{
5+
"name": "next",
6+
"prerelease": true
7+
}
8+
],
9+
"plugins": [
10+
[
11+
"@semantic-release/commit-analyzer",
12+
{
13+
"preset": "angular",
14+
"releaseRules": [
15+
{
16+
"type": "docs",
17+
"scope": "README",
18+
"release": "patch"
19+
}
20+
],
21+
"parserOpts": {
22+
"noteKeywords": [
23+
"BREAKING CHANGE",
24+
"BREAKING CHANGES"
25+
]
26+
}
27+
}
28+
],
29+
"@semantic-release/release-notes-generator",
30+
[
31+
"@semantic-release/changelog",
32+
{
33+
"changelogFile": "CHANGELOG.md"
34+
}
35+
],
36+
[
37+
"@semantic-release/npm",
38+
{
39+
"pkgRoot": "plugin"
40+
}
41+
],
42+
[
43+
"@semantic-release/git",
44+
{
45+
"assets": [
46+
"plugin/package.json",
47+
"CHANGELOG.md"
48+
]
49+
}
50+
],
51+
"@semantic-release/github"
52+
]
53+
}

‎CHANGELOG.md

+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
## [1.6.1](https://github.com/queen-raae/gatsby-plugin-starter/compare/v1.6.0...v1.6.1) (2022-02-03)
2+
3+
# [1.6.0](https://github.com/queen-raae/gatsby-plugin-starter/compare/v1.5.0...v1.6.0) (2022-02-03)
4+
5+
### Features
6+
7+
- better default plugin ([c9d417a](https://github.com/queen-raae/gatsby-plugin-starter/commit/c9d417ac731df6657ce71b681d2ee44803d89339))
8+
9+
# [1.5.0](https://github.com/queen-raae/gatsby-plugin-starter/compare/v1.4.0...v1.5.0) (2022-02-01)
10+
11+
### Features
12+
13+
- uprade dependencies ([25cc493](https://github.com/queen-raae/gatsby-plugin-starter/commit/25cc49395b19c63f6eb76bc85b7df17d5690be2e))
14+
15+
# [1.4.0](https://github.com/queen-raae/gatsby-plugin-starter/compare/v1.3.1...v1.4.0) (2021-11-22)
16+
17+
### Bug Fixes
18+
19+
- clean up package.json ([a7b93fa](https://github.com/queen-raae/gatsby-plugin-starter/commit/a7b93fa44abb7beebe131c140e0e47c67cbf11a7))
20+
21+
### Features
22+
23+
- add code of conduct, closes [#16](https://github.com/queen-raae/gatsby-plugin-starter/issues/16) ([073f528](https://github.com/queen-raae/gatsby-plugin-starter/commit/073f52827d32e672fa3e3ef9cab567030c762202))
24+
- add peer dependencies, closes [#15](https://github.com/queen-raae/gatsby-plugin-starter/issues/15) ([c58473c](https://github.com/queen-raae/gatsby-plugin-starter/commit/c58473c7151b6bfc55304c1b69d09b96dc39d935))
25+
26+
## [1.3.1](https://github.com/queen-raae/gatsby-plugin-starter/compare/v1.3.0...v1.3.1) (2021-11-22)
27+
28+
### Bug Fixes
29+
30+
- Correct utm_campaign in readme ([66d4956](https://github.com/queen-raae/gatsby-plugin-starter/commit/66d4956ba6203de6da4f5d99a4cc37cd9cd91d4f))
31+
32+
# [1.3.0](https://github.com/queen-raae/gatsby-plugin-starter/compare/v1.2.0...v1.3.0) (2021-11-21)
33+
34+
### Features
35+
36+
- automate prettier, closes [#11](https://github.com/queen-raae/gatsby-plugin-starter/issues/11) ([#14](https://github.com/queen-raae/gatsby-plugin-starter/issues/14)) ([c555128](https://github.com/queen-raae/gatsby-plugin-starter/commit/c555128ba1190266c0ded1b8e6ba9b58e0b0a4b9))
37+
38+
# [1.2.0](https://github.com/queen-raae/gatsby-plugin-starter/compare/v1.1.0...v1.2.0) (2021-11-21)
39+
40+
### Features
41+
42+
- add semantic release github plugin, closes [#10](https://github.com/queen-raae/gatsby-plugin-starter/issues/10) ([34cf3ae](https://github.com/queen-raae/gatsby-plugin-starter/commit/34cf3ae60eeb097568eaabaf154cf52411bd75e6))
43+
44+
# [1.1.0](https://github.com/queen-raae/gatsby-plugin-starter/compare/v1.0.0...v1.1.0) (2021-11-21)
45+
46+
### Features
47+
48+
- semantic changelog closes [#7](https://github.com/queen-raae/gatsby-plugin-starter/issues/7) ([#13](https://github.com/queen-raae/gatsby-plugin-starter/issues/13)) ([a179c22](https://github.com/queen-raae/gatsby-plugin-starter/commit/a179c2290c0f3ed9e373da91bfe0101cc4d46065))

‎CODE_OF_CONDUCT.md

+131
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,131 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, caste, color, religion, or sexual
10+
identity and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
- Demonstrating empathy and kindness toward other people
21+
- Being respectful of differing opinions, viewpoints, and experiences
22+
- Giving and gracefully accepting constructive feedback
23+
- Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
- Focusing on what is best not just for us as individuals, but for the overall
26+
community
27+
28+
Examples of unacceptable behavior include:
29+
30+
- The use of sexualized language or imagery, and sexual attention or advances of
31+
any kind
32+
- Trolling, insulting or derogatory comments, and personal or political attacks
33+
- Public or private harassment
34+
- Publishing others' private information, such as a physical or email address,
35+
without their explicit permission
36+
- Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at [[email protected]](mailto://[email protected]).
63+
All complaints will be reviewed and investigated promptly and fairly.
64+
65+
All community leaders are obligated to respect the privacy and security of the
66+
reporter of any incident.
67+
68+
## Enforcement Guidelines
69+
70+
Community leaders will follow these Community Impact Guidelines in determining
71+
the consequences for any action they deem in violation of this Code of Conduct:
72+
73+
### 1. Correction
74+
75+
**Community Impact**: Use of inappropriate language or other behavior deemed
76+
unprofessional or unwelcome in the community.
77+
78+
**Consequence**: A private, written warning from community leaders, providing
79+
clarity around the nature of the violation and an explanation of why the
80+
behavior was inappropriate. A public apology may be requested.
81+
82+
### 2. Warning
83+
84+
**Community Impact**: A violation through a single incident or series of
85+
actions.
86+
87+
**Consequence**: A warning with consequences for continued behavior. No
88+
interaction with the people involved, including unsolicited interaction with
89+
those enforcing the Code of Conduct, for a specified period of time. This
90+
includes avoiding interactions in community spaces as well as external channels
91+
like social media. Violating these terms may lead to a temporary or permanent
92+
ban.
93+
94+
### 3. Temporary Ban
95+
96+
**Community Impact**: A serious violation of community standards, including
97+
sustained inappropriate behavior.
98+
99+
**Consequence**: A temporary ban from any sort of interaction or public
100+
communication with the community for a specified period of time. No public or
101+
private interaction with the people involved, including unsolicited interaction
102+
with those enforcing the Code of Conduct, is allowed during this period.
103+
Violating these terms may lead to a permanent ban.
104+
105+
### 4. Permanent Ban
106+
107+
**Community Impact**: Demonstrating a pattern of violation of community
108+
standards, including sustained inappropriate behavior, harassment of an
109+
individual, or aggression toward or disparagement of classes of individuals.
110+
111+
**Consequence**: A permanent ban from any sort of public interaction within the
112+
community.
113+
114+
## Attribution
115+
116+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
117+
version 2.1, available at
118+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
119+
120+
Community Impact Guidelines were inspired by
121+
[Mozilla's code of conduct enforcement ladder][mozilla coc].
122+
123+
For answers to common questions about this code of conduct, see the FAQ at
124+
[https://www.contributor-covenant.org/faq][faq]. Translations are available at
125+
[https://www.contributor-covenant.org/translations][translations].
126+
127+
[homepage]: https://www.contributor-covenant.org
128+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
129+
[mozilla coc]: https://github.com/mozilla/diversity
130+
[faq]: https://www.contributor-covenant.org/faq
131+
[translations]: https://www.contributor-covenant.org/translations

‎CONTRIBUTING.md

+71
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
# Welcome to Gatsby Plugin Starter docs contributing guide <!-- omit in toc -->
2+
3+
Thank you for your interest in contributing to the Gatsby Plugin Starter.
4+
5+
Both [code](https://github.com/queen-raae/gatsby-plugin-starter/blob/main/CONTRIBUTING.md#contribute-with-code) and [other types](https://github.com/queen-raae/gatsby-plugin-starter/blob/main/CONTRIBUTING.md#contribute-in-other-ways) of contributions are welcome.
6+
7+
## Getting started
8+
9+
- Read our [Code of Conduct](./CODE_OF_CONDUCT.md) to keep our community approachable and respectable.
10+
- Read the [README](README.md) to get an overview of the project.
11+
- Browse the [issues](https://github.com/queen-raae/gatsby-plugin-starter/issues) and [discussions](https://github.com/queen-raae/gatsby-plugin-starter/discussions) already taking place to familiarize yourself with the state of the project.
12+
13+
## Contribute with code
14+
15+
You may either solve an exciting [issue](https://github.com/queen-raae/gatsby-plugin-starter/issues), or create a new [issue](https://github.com/queen-raae/gatsby-plugin-starter/issues/new).
16+
17+
Either way, make sure to outline your plan of action and get some feedback before spending too much time on your solution.
18+
19+
If you are new to open source code contributions, here are some links to get you started:
20+
21+
- [Set up Git](https://docs.github.com/en/get-started/quickstart/set-up-git)
22+
- [Collaborating with pull requests](https://docs.github.com/en/github/collaborating-with-pull-requests)
23+
24+
### Fork, Clone and Install
25+
26+
1. Fork this repository
27+
2. Clone the fork to your local machine: `git clone /[email protected]:<username>/gatsby-plugin-starter.git`
28+
3. Move into repo folder: `cd gatsby-plugin-starter`
29+
4. Install packages: `yarn install`
30+
31+
#### Yarn Workspace
32+
33+
The project uses [yarn workspace](https://classic.yarnpkg.com/lang/en/docs/workspaces/) to host the plugin and demo codes in one repository.
34+
35+
When installing dependencies, make sure to include `workspace plugin` or `workspace demo` to the command so that dependencies are added to the correct workspace: `yarn workspace plugin add lodash`.
36+
37+
Important note from the yarn workspace docs:
38+
39+
> Be careful when publishing packages in a workspace. If you are preparing your next release and you decided to use a new dependency but forgot to declare it in the package.json file, your tests might still pass locally if another package already downloaded that dependency into the workspace root. However, it will be broken for consumers that pull it from a registry, since the dependency list is now incomplete so they have no way to download the new dependency. Currently, there is no way to throw a warning in this scenario.
40+
41+
### Development
42+
43+
Run demo: `yarn develop`
44+
45+
[TODO] Project structure
46+
[TODO] Style guide
47+
48+
### Testing
49+
50+
[TODO] Add a test and document
51+
52+
### Pull Request
53+
54+
When finished with the changes, create a pull request, also known as a PR.
55+
56+
[TODO] How to name the PR
57+
[TODO] Only squash merge allowed
58+
59+
### Semantic Release
60+
61+
The project uses [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) and [semantic versioning](https://semver.org/) to automate releases by utalizing the [semantic-release](https://semantic-release.gitbook.io/) project.
62+
63+
## Contribute in other ways
64+
65+
### Questions, Feedback and Suggestions
66+
67+
If you have any questions, feedback or suggestions head on over to [discussions](https://github.com/queen-raae/gatsby-plugin-starter/discussions).
68+
69+
### Found a bug?
70+
71+
If you find a bug please open an [issue](https://github.com/queen-raae/gatsby-plugin-starter/issues) and/or create a pull request to fix it.

0 commit comments

Comments
 (0)