-
Notifications
You must be signed in to change notification settings - Fork 4
Legacy API: Contributing
This repository will serve as the authoritative source of production code for the leverage API. This repository should never receive direct pushes from contributors. Contributing changes should instead adhere to the following workflow:
- Fork the api repo to personal GitHub account
- Push changes to personal fork
- Open pull request from personal fork to develop branch of Lever-age/api
- Allow another member of the project to review and merge pull request
Once the "develop" branch is deemed to be feature complete and stable, it should be merged into the master branch and tagged as a release
Pull requests must be opened with the provided checklist. The opener of the pull request is responsible for ensuring that the items in the "Development Checklist" have been verified. The reviewer of the request is responsible for ensuring that the remaining items on the checklist have been verified.
As specified in the pull request template, all methods should be documented. Method documentation should be written inline using JSDoc syntax
For any class which is added to the API implementation, unit tests should be provided for each method. More detailed expectations of what needs to be tested are specified in the pull request template.
Unit tests for this project are implemented using mocha, and chai is used to perform assertions within tests.
Each class being tested should have its own module placed under the test/ subdirectory which is named after the class for which it contains tests (e.g., a class named CampaignInfo should have all of its tests contained in a module named test/campaign-info.js).