We want to keep it as easy as possible to contribute changes Encore. There are a few guidelines that we need to follow so that we can have a chance of keeping on top of things.
Please submit any bugs you encounter when using Encore UI to our Github Issues Tracker.
When submiting a bug report, please include a set of steps to reproduce the issue and any related information (browser, OS, etc). If we can't reproduce the issue then it makes fixing it much more difficult.
If you haven't already, let the Racker Tools team know what your plans are. This is important so that time isn't spent by separate teams doing the same thing, and so that the team can get an initial round of feedback in before coding starts.
An API review validates your initial approach
A design review validates your high-level architecture
A code review validates your implementation details
Encore UI Developer Setup - How to install the Encore UI codebase
The process for any code updates follows the GitHub Flow model.
To sum up:
- Create a new branch in your local repo
- Commit to that branch
- Push branch up to Github
- Submit PR to for review
- Once reviewed and feedback given (and implemented), we will merge the branch to master
Any libraries added to the project must be pre-approved with the UI team.
Get into the habit of running git diff or git diff --cached before every commit. This helps ensure no unwanted changes sneak in. Also, check for unnecessary whitespace with git diff --check.
You should keep each commit as granular as possible. For instance, do not check in 2 bug fixes in one commit -- separate them out into 2 commits.
We use the same commit format that the Angular Team follows. Any commits that don't follow this format will be rejected.
- Run all the tests to assure nothing else was accidentally broken.
- Unit Tested - Minimum coverage requirement - 80% (simple controllers/services may not need to be unit tested, depending on how basic their logic is)
- Midways tests also need to be created for any new components
Before submitting any changes, make sure the master branch is merged locally into your branch (using Git rebase is preferred). Once done, push your branch up to Github and submit a Pull Request.
- Complete documentation (a docs subfolder with working examples and ngdocs), along with inline code comments as beneficial
- Unit tests with 80% line coverage
- Midways tests for all new UI functionality
- Proper commit logs
- Passes JSHint & CSSLint
Once a pull request has been submitted, you simply need to wait for the Encore UI team to respond. Every pull request sends an e-mail out to the team, so there is no need to send any further communication to the team. If the pull request is urgent, that needs to be communicated before the pull request is sent.
We like to at least comment on, if not accept, pull requests within three business days (and, typically, one business day). We may suggest some changes or improvements or alternatives, so make sure there is time for review in your release plan.
Once the contribution has been merged into the repo, if any issues arise in the integration environment or upon subsequent feedback, the contribution may be reverted.