Skip to content

Commit c8767ce

Browse files
tom-sapletta-comtom-sapletta-com
committed
docs files update, archived www and dev repos
1 parent 16c473a commit c8767ce

17 files changed

+808
-8
lines changed

‎.editorconfig

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
root = true
2+
3+
[*]
4+
indent_style = tab
5+
end_of_line = lf
6+
charset = utf-8
7+
trim_trailing_whitespace = true
8+
insert_final_newline = true
9+
10+
[*.yml]
11+
indent_style = space
12+
indent_size = 2

‎.gitattributes

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* text=auto eol=lf

‎.github/CODEOWNERS

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* @webstream/maintainers

‎.github/PULL_REQUEST_TEMPLATE.md

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
## Changes
2+
3+
<!-- What does this change, in plain language? Include screenshots or videos if helpful. -->
4+
5+
## Testing
6+
7+
<!-- How can a reviewer test your code themselves? -->
8+
9+
- [ ] Tests are passing
10+
- [ ] Tests updated where necessary
11+
12+
## Docs
13+
14+
- [ ] Docs / READMEs updated
15+
- [ ] Code comments added where helpful
16+
17+
<!-- Notes, if any -->

‎.github/build.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
2+
## Building the project
3+
4+
The process of building the project is very simple all you need is this:
5+
6+
```bash
7+
clone https://github.com/web-stream/docs.git
8+
cd nodejs
9+
npm install
10+
make
11+
```
12+
13+
While developing you can use -src versions they are work fine. Make will just create
14+
Release files that have proper version number, create minified files and build emoji
15+
css.

‎.github/contributor_list.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
2+
## List of contributors with avatars
3+
4+
To update the list, the script need to be run when change is merged to master and since all merges are done on
5+
devel. I need to run the script when I'm releasing new version. To help me remember, if this is yours first
6+
contribution, please modify template/Makefile.in and update line `UPDATE_CONTRIBUTORS=1` it should be 1 which
7+
is true (0 is false). On each build it will show red reminder message and it will stop build when run on master.

‎.github/edit_readme.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
2+
## README
3+
4+
if you want to modify readme please modify the one in `./templates` directory, because
5+
that one is source file with {{VER}} markers that get filled with current version when
6+
running `make`.

‎.github/funding.yml

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
github: tom-sapletta-com
2+
open_collective: tom-sapletta-com
3+
tidelift: npm/webstream
4+
custom: https://donate.softreck.dev

‎.github/pull_request.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Please follow the below steps:
2+
3+
- **One PR per file type.**
4+
- Add the file extension to the `keywords` array in the `package.json` file.
5+
- Run `$ npm test` to ensure the tests pass.
6+
- Open a pull request with a title like `Add support for Format`, for example, `Add support for ...`.
7+
- The pull request description should include a link to the official page of the file format or some other source.
8+

‎.github/release_cycle.md

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
## Release Cycle
2+
3+
* New version is developed on devel branch
4+
* Each fix and feature need to be added to CHANGELOG.md file
5+
* After random number of feature and bugfixes are done, the code need to be merged with master
6+
7+
```bash
8+
git checkout master
9+
git merge devel --no-ff -m 'merge with devel'
10+
```
11+
12+
* then the next version need to be created, last version from CHANGELOG need to be used
13+
to call version script that rename files that have version at the end.
14+
15+
``bash
16+
./scripts/version 2.21.0
17+
make
18+
git commit -am 'version 2.21.0'
19+
git push
20+
git tag 2.21.0
21+
git push --tags
22+
```
23+
24+
**NOTE:** if something is wrong (e.g. Travis CI failed) the tag can be removed, fix can be added
25+
in new commit and tag need to be added again.
26+
27+
* Now version on GitHub is released. You need to wait a bit to have confirmation
28+
from CI that the build was successful. In mean time you can add Release Notes
29+
on GitHub. Just click releases -> draft new release then pick the version
30+
and copy paste what's in CHANGELOG.md file.
31+
32+
* After you git confirmation that CI (travis) run successfully you can release
33+
to npm. By calling:
34+
35+
```bash
36+
make publish
37+
```
38+
39+
* Script will clone the repo (just in case you have lot of files in repo that you
40+
don't want to publish to npm) into ./npm directory and run `npm publish`,
41+
after that it will delete the directory.
42+
43+
* New version is ready.

‎.github/security.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Security Policy
2+
3+
To report a security vulnerability,
4+
please use the [Tidelift security contact](https://tidelift.com/security).
5+
Tidelift will coordinate the fix and disclosure.

‎.github/test.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
2+
## Test
3+
4+
You should run test to make sure you don't break anything, to run tests from browser you need to run
5+
6+
```bash
7+
npm install
8+
make test
9+
```
10+
11+
and run ESlint and JSONLint using:
12+
13+
```bash
14+
make lint
15+
```
16+
you can also run test coverage using
17+
18+
```bash
19+
make coverage
20+
```

‎.gitignore

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
.idea/
2+
apicra.php
3+
#.apibuild
4+
15
# Logs
26
logs
37
*.log

‎.vscode/launch.json

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
// A launch configuration that compiles the extension and then opens it inside a new window
2+
{
3+
"version": "0.2.0",
4+
"configurations": [
5+
{
6+
"name": "Launch Client",
7+
"type": "extensionHost",
8+
"request": "launch",
9+
"runtimeExecutable": "${execPath}",
10+
"args": ["--extensionDevelopmentPath=${workspaceRoot}/tools/webstream-vscode"],
11+
"outFiles": ["${workspaceRoot}/tools/webstream-vscode/dist/**/*.js"]
12+
},
13+
{
14+
"type": "node",
15+
"request": "attach",
16+
"name": "Attach to Server",
17+
"port": 6040,
18+
"restart": true,
19+
"outFiles": ["${workspaceRoot}/tools/webstream-languageserver/dist/**/*.js"],
20+
"skipFiles": ["<node_internals>/**"]
21+
}
22+
],
23+
"compounds": [
24+
{
25+
"name": "Launch Extension",
26+
"configurations": ["Launch Client", "Attach to Server"]
27+
}
28+
]
29+
}

‎.vscode/tasks.json

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
{
2+
"version": "2.0.0",
3+
"tasks": [
4+
{
5+
"type": "npm",
6+
"script": "build:vscode",
7+
"group": "build",
8+
"presentation": {
9+
"panel": "dedicated",
10+
"reveal": "never"
11+
}
12+
}
13+
]
14+
}

0 commit comments

Comments
 (0)