-
Notifications
You must be signed in to change notification settings - Fork 23
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updated to match format of [X9Developers/block-explorer][1]. It is now just a copy of the readme for X9Developers/block-explorer with a couple of names changed. Resolves #28 [1]: https://github.com/X9Developers/block-explorer/blob/develop/CONTRIBUTING.md
- Loading branch information
Showing
1 changed file
with
26 additions
and
4 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 |
---|---|---|
@@ -1,8 +1,30 @@ | ||
# Contributing | ||
This is an incomplete list of things to take care while contributing. | ||
|
||
This is an incomplete list of things to take care while contributing: | ||
- Every commit message should have this format `$project: title` being `$project` one of `alerts-server`, `alerts-ui` or `root`, see the [commit list](https://github.com/AlexITC/crypto-coin-alerts/commits/master) to get a better idea. | ||
- Try to keep the code style while we integrate a code formatter tool like scalafmt. | ||
## Commits | ||
- Every commit message should have this format `$project: title` being `$project` one of `alerts-server`, `alerts-ui` or `infra`, see the [commit list](https://github.com/AlexITC/crypto-coin-alerts/commits/master) to get a better idea, also, the message should be meaningful and describe what is changed. | ||
- Don't touch files or pieces non-related to the commit message, create a different commit instead. | ||
- Keep the commits simple to make the reviews easy. | ||
- Avoid merge commits, use rebase instead. | ||
- Merge commits will be rejected, use rebase instead, run `git config pull.rebase true` after cloning the repository to rebase automatically. | ||
- Every commit should have working code with all tests passing. | ||
- Every commit should include tests unless it is not practical. | ||
|
||
## Code style | ||
- Try to keep the code style while we integrate a code formatter tool like scalafmt. | ||
|
||
## Pull requests | ||
- Pull requests should go to the `develop` branch. | ||
|
||
## Other | ||
- `master` branch should never be broken, it contains the current version running in production. | ||
|
||
|
||
|
||
## Environment | ||
It is simpler to use the recommended developer environment. | ||
|
||
### alerts-server | ||
- IntelliJ with the Scala plugin. | ||
|
||
### alerts-ui | ||
Use [TSLint](https://palantir.github.io/tslint/) to keep the code format consistent, please run `tslint -c tslint.json 'src/**/*.ts'` and fix the errors before every commit, or use [visual code](https://code.visualstudio.com/) with the `Angular Language Service` and `TSLint` plugin to see the errors while typing. |