Skip to content

Commit 660af4b

Browse files
AvaqAvaq
authored
Merge pull request #1 from fluture-js/everything
Add everything
2 parents fbaea61 + 95752b3 commit 660af4b

File tree

16 files changed

+189
-1
lines changed

16 files changed

+189
-1
lines changed

‎.config‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
author-name = Aldwin Vlasblom
2+
repo-owner = fluture-js
3+
repo-name = fluture-project
4+
source-files = index.js
5+
module-type = esm
6+
opening-delimiter = ```js

‎.editorconfig‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
root = true
2+
3+
[*]
4+
indent_style = space
5+
indent_size = 2
6+
end_of_line = lf
7+
charset = utf-8
8+
trim_trailing_whitespace = true
9+
insert_final_newline = true

‎.eslintrc.json‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
{
2+
"root": true,
3+
"extends": ["./node_modules/sanctuary-style/eslint-es3.json"],
4+
"parserOptions": {"sourceType": "module"},
5+
"env": {"node": true, "es6": true},
6+
"overrides": [
7+
{
8+
"files": ["README.md"],
9+
"rules": {"no-undef": ["off"]}
10+
}
11+
]
12+
}

‎.github/PULL_REQUEST_TEMPLATE/initial-pr.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
name: Initial pull request
3+
about: When you've just generated this repository and you want to get to work.
4+
---
5+
6+
# Everything
7+
8+
This pull request adds everything the project needs to be at its first release.
9+
10+
# TODO
11+
12+
- [ ] Update `author-name` and `repo-owner` in `.config` and
13+
ensure the tests pass.
14+
15+
- [ ] Name the project:
16+
- Change `repo-name` in `.config` and ensure the tests pass.
17+
- Change the header of the documentation in `index.js`.
18+
- Change the module name in `rollup.config.js`.
19+
20+
- [ ] Describe the project:
21+
- Change `description` in `package.json`
22+
- Update the GitHub repo description.
23+
- Add the description to the documentation in `index.js`.
24+
25+
- [ ] If this is a node-only module, remove browser support:
26+
- Change `umd` to `cjs` in `rollup.config.js` and remove `output.name`.
27+
- Change `eslint-es3` to `eslint-es6` in `.eslintrc.json`.
28+
29+
- [ ] Remove the `initial-pr.md` pull-request template.
30+
31+
- [ ] Write the code.

‎.gitignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
/coverage/
2+
/index.cjs
3+
/node_modules/

‎.npmrc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
package-lock=false

‎.travis.yml‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
language: node_js
2+
node_js:
3+
- "12"
4+
after_success: npm run codecov
5+
branches:
6+
only:
7+
- master

‎CONTRIBUTING.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Contribution Guideline
2+
3+
## Making a contribution
4+
5+
1. Fork the repo if you do not have write access
6+
1. Clone the remote (fork) from GitHub
7+
1. Create a branch named `<yourgithubusername>/<yourfeature>`
8+
1. Make one or more atomic commits
9+
1. Make sure the tests pass locally
10+
1. Create a pull request on GitHub
11+
12+
## Publishing a new version
13+
14+
1. Make sure you have write access to the module on npm
15+
1. Make sure you have write access to the master branch on GitHub
16+
1. Checkout `master` and make sure it's up to date with the remote
17+
1. Run `npm run release <level>`, where `<level>` can be any of: 'major',
18+
'minor', 'patch', 'premajor', 'preminor', 'prepatch', or 'prerelease'.

‎LICENSE‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
The MIT License (MIT)
2+
Copyright (c) 2019 Aldwin Vlasblom
3+
4+
Permission is hereby granted, free of charge, to any person obtaining a copy of
5+
this software and associated documentation files (the "Software"), to deal in
6+
the Software without restriction, including without limitation the rights to
7+
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
8+
of the Software, and to permit persons to whom the Software is furnished to do
9+
so, subject to the following conditions:
10+
11+
The above copyright notice and this permission notice shall be included in all
12+
copies or substantial portions of the Software.
13+
14+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20+
SOFTWARE.

‎README.md‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,4 @@
1-
# Fluture Project
1+
# Under Construction
2+
3+
This project is still under construction. If all went well, you should be
4+
able to learn about it in the [initial pull request](./pull/1).

0 commit comments

Comments
 (0)