-
Notifications
You must be signed in to change notification settings - Fork 24
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #440 from GrimoireGL/semantic-release
Enable semantic-release on CI
- Loading branch information
Showing
14 changed files
with
970 additions
and
78 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -123,3 +123,4 @@ register | |
ref | ||
test-es5 | ||
src/index.ts | ||
yarn.lock |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
# Guideline for contribution[WIP] | ||
|
||
## Got a questions or problem? | ||
|
||
Using slack is the best way to ask main contributors. | ||
Stack overflow is another choice to ask. | ||
|
||
## Found bugs? | ||
|
||
Please report them with issues. You can write it in English or Japanese. | ||
If reporter write an issue with Japanese and it is fatal problem of this library, | ||
main contributors would translate them for convenience. | ||
|
||
## Contributing to translation | ||
|
||
We prepare to translate all of our documents written in Japanese to English. | ||
Currently official site and most of documents are written in Japanese, but we will move the main language as English. | ||
This is including a lot of stuff to do, we need contributors. Even if you correct our English syntax, we are welcome. | ||
|
||
## Contributing to code | ||
|
||
Reducing works we need to do manually is very important. | ||
Please read this guideline for keeping clean repository and keeping developing environment efficiently. | ||
|
||
### Coding rule | ||
|
||
Most of the coding rules are checked with `TSLint`. You can run `npm run lint` to check whether your code is fitting to coding rule. | ||
Lint task would run on CI also. | ||
|
||
But, there are some coding rule not listed in tslint configurations. These rules are listed below. | ||
|
||
#### Rules of methods | ||
|
||
```ts | ||
public publicMethod(): void; | ||
private _privateMethod(): void; | ||
protected __protectedMethod(): void; | ||
``` | ||
|
||
Public method name must begin with lower case and should following names are `camelCase`. | ||
Private method name must begin with `_`, and following characters are same as public method name. | ||
Protected method name must begin with two `__`, and following characters are same as public method name. | ||
|
||
### Commit message guideline | ||
|
||
Currently the version of this package is managed by `semantic-release`. | ||
To generate changelog and release new version automatically, please follow this rule. | ||
|
||
#### When the commit is bug fix,refactor or chore (Anything no effect for API). | ||
|
||
``` | ||
fix: COMMIT MESSAGE HERE | ||
``` | ||
|
||
#### When the commit contains new feature not containing breaking change. | ||
|
||
``` | ||
feat: COMMIT MESSAGE HERE | ||
``` | ||
|
||
#### When the commit contains breaking change | ||
|
||
But, keeping in mind that we should not break public API. | ||
|
||
``` | ||
perf: COMMIT MESSAGE HERE | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +1,22 @@ | ||
general: | ||
branches: | ||
ignore: | ||
- gh-pages | ||
machine: | ||
timezone: Asia/Tokyo | ||
node: | ||
version: 6.5.0 | ||
node: | ||
version: 6.9.5 | ||
|
||
post: | ||
- curl -o- -L https://yarnpkg.com/install.sh | bash | ||
|
||
dependencies: | ||
cache_directories: | ||
- "~/.cache/yarn" | ||
|
||
pre: | ||
- yarn --version | ||
|
||
override: | ||
- yarn install | ||
|
||
test: | ||
post: | ||
- npm run semantic-release || true | ||
override: | ||
- npm run build && npm test | ||
- npm run lint && npm run build && npm test |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.