Developing for Accord Project
This document describes how to set up your development environment to build and test Cicero-UI, and
explains the basic mechanics of using
Before you can build Cicero-UI, you must install and configure the following dependencies on your machine:
Node.js v10.16.0 'Dubnium' (LTS): We use Node to generate the documentation, run a development web server, run tests, and generate distributable files. Depending on your system, you can install Node either from source or as a pre-packaged bundle.
Forking Accord Project repositories on Github
To contribute code to Accord Project, you must have a GitHub account so you can push code to your own fork of an Accord Project repository and open Pull Requests in the repository.
Building a Project
To build a project, you clone the source code repository and use npm to build:
# Clone your Github repository: git clone https://github.com/<github username>/<repository>.git # Go to the directory: cd <repository> # Add the main repository as an upstream remote to your repository: git remote add upstream "https://github.com/accordproject/<repository>.git" # Go to website directory cd website # Install node.js dependencies: npm install
Running the Project Locally
This project uses Docusaurus to build and manage the public Accord Project documentation website. To run the documentation website on your local machine, first, follow the instructions above to build the project.
# Change to the website directory cd website # Start the docusaurus server npm start
Changes that you make to markdown files in the
/docs folder will automatically be reflected in your local running version of the documentation website.
Keeping In Sync
It is good practice to always keep your
origin/master in sync with
upstream/master. You don’t have to, but it makes your life easier. Do your work in branches of your fork, and periodically sync up your
master with the
upstream as follows. You should definitely do this before creating a pull request.
git fetch --all --prune git checkout master git merge --ff-only upstream/master git push origin master
We write unit and integration tests with Enzyme and execute them with Jest. To run all of the tests once on Chrome run:
npm run test
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.
- All public API methods must be documented with jsdoc. To see how we document our APIs, please check out the existing source code and see the section about writing documentation
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 and git logs.
But also, we use the git commit messages to generate the Cicero-UI change log.
The commit message formatting can be added using a version of typical git workflow.
Commit Message Format
Each commit message consists of a mandatory type, scope, subject, and footer. This is a specific format:
<type>(<scope>): <subject> - <footer>
This allows the message to be easier to read on GitHub as well as in various git tools.
If the commit reverts a previous commit, it should begin with
revert: , followed by the subject, where it
this reverts commit <hash>., where the hash is the SHA of the commit being reverted.
A commit with this format is automatically created by the [
git revert][git-revert] command.
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
perf: A code change that improves performance
test: Adding missing or correcting existing tests
chore: Changes to the build process or auxiliary tools and libraries such as documentation generation
The scope will be specifying the place of the commit change; the focal point of new code or best description for where changes can be found.
You can use
* when the change affects more than a single scope.
The subject contains a succinct description of the change:
- use the imperative, present tense: "change" not "changed" nor "changes"
- don't capitalize the first letter
- kept under 50 characters
- no dot (.) at the end
The footer should contain reference GitHub Issues that this commit addresses.
Pull Requests should consist of a complete addition to the code which contains value. Because the commits inside follow a pattern, the title should be an extension or summary of all the commits inside.
Pull Request titles should follow commit message formatting.
Formatting for the body is displayed in this example:
# Issue #20 ### Changes - Change one - Subchange one - Subchange two - Change two - Theoretically this should be listing all the commit messages included in this PR ### Flags - Possible issues or holds for reviewers to note - List any breaking changes here. ### Related Issues - Link any issues or pull requests relating to this
When approved and ready to merge, a Pull Request should be squashed down to a single buildable commit and merged into master.
The Accord Project repositories use jsdoc for all of its code documentation.
This means that all the docs are stored inline in the source code and so are kept in sync as it changes.
This means that since we generate the documentation from the source code, we can easily provide version-specific documentation by checking out a version of Cicero-UI and running the build.
Accord Project source code files are made available under the Apache License, Version 2.0.
Accord Project documentation files are made available under the Creative Commons Attribution 4.0 International License (CC-BY-4.0).