Accuser is a lightweight framework to help you write Github bots that monitor issues and pull requests and work with them. The framework wraps around the octokit library to make it easier to monitor pull requests, assign people and write comments.
- Issues and Pull Requests filtering
- Accuse / Assigning PRs
- Commenting
- Labels
To use Accuser in your project, run npm install --save nus-cs2103/accuser#release. Please note:
- Always use the
releasebranch, as other branches may be unstable or broken. - Your Node.js version should be greater or equal to
8.10.0.
- Webhooks / Event Implementation
- Renaming Title
Accuser uses Mocha for unit testing. To perform testing:
- Ensure that development dependencies are installed.
- Run the following command
npm test.
To make changes:
- Follow Airbnb's JavaScript Style Guide at here.
- In this project, we use the
eslint-config-airbnb-basepreset and make reasonable adjustments in.eslintrc.js.
- In this project, we use the
- Try not to break existing APIs.
To include your changes in the next release:
- Make sure all your code changes have been merged into the
masterbranch via pull requests (preferred), direct commits, etc. - Update the
versiondefined inpackage.json. Please use semantic versioning. - Create a new release using the new
versionyou defined just now. - Ask any project member with required privileges to sync the
releasebranch with themasterbranch- To make the Git history clean, a Git rebase is preferred over merge.
- Switch to the
releasebranch and create a tag named as the newversionyou defined. - Push the changes (as well as the new tag) to GitHub.