Skip to content

Commit cc40521

Browse files
committed
chore: inital commit
1 parent ecdfc12 commit cc40521

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

75 files changed

+33770
-34
lines changed

Diff for: .editorconfig

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@ trim_trailing_whitespace = true
55
indent_size = 2
66

77
[*.md]
8-
indent_size = 4
8+
indent_size = 4

Diff for: .github/wofklows/ci.yml

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
name: Test & Lint
2+
on: [push]
3+
4+
jobs:
5+
build:
6+
runs-on: ubuntu-latest
7+
8+
strategy:
9+
matrix:
10+
node-version: ['18.x', '20.x']
11+
12+
steps:
13+
- uses: actions/checkout@v4
14+
- name: Use Node.js ${{ matrix.node-version }}
15+
uses: actions/setup-node@v4
16+
with:
17+
node-version: ${{ matrix.node-version }}
18+
- run: npm i
19+
- run: npm run ci

Diff for: .gitignore

+133-8
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,133 @@
1-
# This is an extremely basic .gitignore file!
2-
#
3-
# As you start building out your project, you'll probably want to add more here.
4-
# For some good, language/tool-specific .gitignore examples, check out:
5-
# https://github.com/github/gitignore
6-
7-
.DS_Store
8-
scratch.*
1+
# Logs
2+
logs
3+
*.log
4+
npm-debug.log*
5+
yarn-debug.log*
6+
yarn-error.log*
7+
lerna-debug.log*
8+
.pnpm-debug.log*
9+
10+
# Diagnostic reports (https://nodejs.org/api/report.html)
11+
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
12+
13+
# Runtime data
14+
pids
15+
*.pid
16+
*.seed
17+
*.pid.lock
18+
19+
# Directory for instrumented libs generated by jscoverage/JSCover
20+
lib-cov
21+
22+
# Coverage directory used by tools like istanbul
23+
coverage
24+
*.lcov
25+
26+
# nyc test coverage
27+
.nyc_output
28+
29+
# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
30+
.grunt
31+
32+
# Bower dependency directory (https://bower.io/)
33+
bower_components
34+
35+
# node-waf configuration
36+
.lock-wscript
37+
38+
# Compiled binary addons (https://nodejs.org/api/addons.html)
39+
build/Release
40+
41+
# Dependency directories
42+
node_modules/
43+
jspm_packages/
44+
45+
# Snowpack dependency directory (https://snowpack.dev/)
46+
web_modules/
47+
48+
# TypeScript cache
49+
*.tsbuildinfo
50+
51+
# Optional npm cache directory
52+
.npm
53+
54+
# Optional eslint cache
55+
.eslintcache
56+
57+
# Optional stylelint cache
58+
.stylelintcache
59+
60+
# Microbundle cache
61+
.rpt2_cache/
62+
.rts2_cache_cjs/
63+
.rts2_cache_es/
64+
.rts2_cache_umd/
65+
66+
# Optional REPL history
67+
.node_repl_history
68+
69+
# Output of 'npm pack'
70+
*.tgz
71+
72+
# Yarn Integrity file
73+
.yarn-integrity
74+
75+
# dotenv environment variable files
76+
.env
77+
.env.development.local
78+
.env.test.local
79+
.env.production.local
80+
.env.local
81+
82+
# parcel-bundler cache (https://parceljs.org/)
83+
.cache
84+
.parcel-cache
85+
86+
# Next.js build output
87+
.next
88+
out
89+
90+
# Nuxt.js build / generate output
91+
.nuxt
92+
dist
93+
94+
# Gatsby files
95+
.cache/
96+
# Comment in the public line in if your project uses Gatsby and not Next.js
97+
# https://nextjs.org/blog/next-9-1#public-directory-support
98+
# public
99+
100+
# vuepress build output
101+
.vuepress/dist
102+
103+
# vuepress v2.x temp and cache directory
104+
.temp
105+
.cache
106+
107+
# Docusaurus cache and generated files
108+
.docusaurus
109+
110+
# Serverless directories
111+
.serverless/
112+
113+
# FuseBox cache
114+
.fusebox/
115+
116+
# DynamoDB Local files
117+
.dynamodb/
118+
119+
# TernJS port file
120+
.tern-port
121+
122+
# Stores VSCode versions used for testing VSCode extensions
123+
.vscode-test
124+
125+
# yarn v2
126+
.yarn/cache
127+
.yarn/unplugged
128+
.yarn/build-state.yml
129+
.yarn/install-state.gz
130+
.pnp.*
131+
132+
dist
133+
NOTES.txt

Diff for: .husky/commit-msg

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
npx --no -- commitlint --edit $1

Diff for: .husky/pre-commit

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
npm test

Diff for: .prettierrc

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{ "trailingComma": "es5", "tabWidth": 2, "semi": false, "singleQuote": true }

Diff for: CONTRIBUTING.md

-7
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ is not the only way to help the community. Answering questions, helping
55
others, reaching out, and improving the documentation are all immensely valuable
66
to the community.
77

8-
98
## You can contribute in so many ways!
109

1110
There are 3 ways you can contribute to this project:
@@ -18,14 +17,12 @@ _All are equally valuable to the community._
1817

1918
We also onboard new volunteers to USDR projects in general at [https://www.usdigitalresponse.org/raisingyourhand](https://www.usdigitalresponse.org/raisingyourhand). Please sign up if you’d like to help on other projects.
2019

21-
2220
## Submitting a new issue or feature request
2321

2422
Do your best to follow these guidelines when submitting an issue or a feature
2523
request. It will make it easier for us to come back to you quickly and with good
2624
feedback.
2725

28-
2926
### Did you find a bug?
3027

3128
Open source code is robust and reliable thanks to the users who notify us of
@@ -41,7 +38,6 @@ Did not find it? :( So we can act quickly on it, please include the following:
4138
- If the problem was with the demo UI or docs pages, your **browser (e.g. Firefox, Chrome, Edge, Internet Explorer)**.
4239
- Any code errors that you have access to.
4340

44-
4541
### Do you want a new feature?
4642

4743
A world-class feature request addresses the following points:
@@ -58,7 +54,6 @@ A world-class feature request addresses the following points:
5854
If your issue is well written, we’re already 80% of the way there by the time you
5955
post it.
6056

61-
6257
## Start contributing! (Pull Requests)
6358

6459
Before writing code, we strongly advise you to search through the exising PRs or
@@ -120,7 +115,6 @@ Follow these steps to start contributing:
120115
branch and push the changes to your fork. They will automatically appear in
121116
the pull request.
122117

123-
124118
### Checklist
125119

126120
1. The title of your pull request should be a summary of its contribution;
@@ -136,5 +130,4 @@ Follow these steps to start contributing:
136130

137131
4. If there are any tests, make sure that they pass and cover your new features and bugfixes.
138132

139-
140133
#### This guide was based on [HuggingFace/transformers](https://github.com/huggingface/transformers/blob/master/CONTRIBUTING.md) which was itself based on [SciKit-Learn](https://github.com/scikit-learn/scikit-learn/blob/master/CONTRIBUTING.md)

Diff for: LICENSE

+1-1
Original file line numberDiff line numberDiff line change
@@ -198,4 +198,4 @@
198198
distributed under the License is distributed on an "AS IS" BASIS,
199199
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200200
See the License for the specific language governing permissions and
201-
limitations under the License.
201+
limitations under the License.

0 commit comments

Comments
 (0)