Before you submit your Pull Request (PR) consider the following guidelines:
-
Fork the seedium/uzert repo or if your already collaborator just miss this step.
-
Make your changes in a new git branch created from master. Git branch should be named in seedium convention (See our Developer Guid):
git checkout -b <prexix>/<task_number or feature_name> master
-
Create your patch, including appropriate test cases.
-
Follow our Coding Rules.
-
Run the full Uzert test suite (see common scripts), and ensure that all tests pass.
-
Commit your changes using a descriptive commit message that follows our commit message conventions. Adherence to these conventions is necessary because release notes are automatically generated from these messages.
git commit -a
Note: the optional commit
-acommand line option will automatically "add" and "rm" edited files. -
Push your branch to GitHub:
git push origin my-branch
-
In GitHub, send a pull request to
uzert:master.
-
If changes was suggested then:
-
Make the required updates.
-
Re-run the Uzert test suites to ensure tests are still passing.
-
Rebase your branch and force push to your GitHub repository (this will update your Pull Request):
git rebase master -i git push -f
-
That's it! Thank you for your contribution!
# build all packages and move to "sample" directories
$ npm run build
# run the full unit tests suite
$ npm run test
# run integration tests
# docker is required(!)
$ sh scripts/run-integration.sh
# run linter
$ npm run lint
# build all packages and put them near to their source .ts files
$ npm run build:prodYou will need Node.js version 10.0.0+.
- After cloning the repo, run:
$ npm i # (or yarn install)- In order to prepare your environment run
prepare.shshell script:
$ sh scripts/prepare.shThat will compile fresh packages and afterward, move them to all sample directories as well as integration tests.
To ensure consistency throughout the source code, keep these rules in mind as you are working:
- All features or bug fixes must be tested by one or more specs (unit-tests).
- We follow coding standards described in Seedium. An automated formatter is available (
npm run format).
We have very precise rules over how our git commit messages can be formatted. This leads to more readable messages that are easy to follow when looking through the project history. But also, we use the git commit messages to generate the Uzert change log.
Each commit message consists of a header, a body and a footer. The header has a special format that includes a type, a scope and a subject:
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
The header is mandatory and the scope of the header is optional.
Any line of the commit message cannot be longer 100 characters! This allows the message to be easier to read on GitHub as well as in various git tools.
Footer should contain a closing reference to an issue if any. or contain link to the closed task in Jira
Samples: (even more samples)
docs(changelog): update change log to beta.5
bugfix(core): fix bootstrap injection
If the commit reverts a previous commit, it should begin with revert:, followed by the header of the reverted commit. In the body it should say: This reverts commit <hash>., where the hash is the SHA of the commit being reverted.
Must be one of the following:
- feat: A new feature
- fix: A bug fix
- docs: Documentation only changes
- style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
- refactor: A code change that neither fixes a bug nor adds a feature
- test: Adding missing tests or correcting existing tests
- chore: updating grunt tasks etc; no production code change
- ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
The scope should be the name of the npm package affected (as perceived by person reading changelog generated from commit messages.
The following is the list of supported scopes:
- app
- config
- core
- http
- logger
- mongo
- server
- validation
- helpers
If changes affects many of scopes, the scope can be missed
There are currently a few exceptions to the "use package name" rule:
- changelog: used for updating the release notes in CHANGELOG.md
The subject contains succinct description of the change:
- use the imperative, present tense: "change" not "changed" nor "changes"
- don't capitalize first letter
- no dot (.) at the end
Just as in the subject, use the imperative, present tense: "change" not "changed" nor "changes". The body should include the motivation for the change and contrast this with previous behavior.
The footer should contain any information about Breaking Changes and is also the place to reference GitHub or Jira issues that this commit Closes.
Breaking Changes should start with the word BREAKING CHANGE: with a space or two newlines. The rest of the commit message is then used for this.