Skip to content

Commit 1ec6fc0

Browse files
committed
chore: prep for open source
1 parent 3c3dc36 commit 1ec6fc0

File tree

6 files changed

+412
-6
lines changed

6 files changed

+412
-6
lines changed

.editorconfig

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
# please upstream changes!
2-
# https://gitlab.servalldatasystems.com/meat-n-potatoes/dotfiles
3-
41
root = true
52

63
[*]

.gitignore

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
# please upstream changes!
2-
# https://gitlab.servalldatasystems.com/meat-n-potatoes/dotfiles
3-
41
node_modules/
52

63
# config

.gitlab-ci.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,3 +24,7 @@ test:
2424
publish:
2525
extends: .node-publish-tag
2626
stage: publish
27+
28+
publish-public:
29+
extends: .node-publish-tag-public
30+
stage: publish

CONTRIBUTING.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
## Contributing to this package
2+
Thank you for your interest in contributing!
3+
4+
Below is a 'quick start' guide to developing. If there are details
5+
that we are missing here, feel free to file an issue or correct mistakes!
6+
7+
### Building
8+
We use `yarn`, and you should too if you plan to add or remove any npm packages.
9+
10+
```
11+
# installs 3rd party dependencies
12+
yarn install
13+
14+
# runs typescript and outputs in ./dist
15+
yarn build
16+
17+
# runs the unit tests
18+
yarn test
19+
20+
# runs our linter
21+
yarn lint
22+
```
23+
24+
The `build` and `test` command have a `--watch` option that will intelligently re-run when files change.
25+
26+
### Pull Request
27+
We will happily accept pull requests of any kind. Be sure that the tests
28+
pass and that the linter is happy before filling a PR, otherwise we'll
29+
need to tell you to fix those issues.
30+
31+
If you are adding anything new or changing behavior, please add applicable tests.

0 commit comments

Comments
 (0)