Accuser

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

Getting Started

To use Accuser in your project, run npm install --save nus-cs2103/accuser#release. Please note:

• Always use the release branch, as other branches may be unstable or broken.
• Your Node.js version should be greater or equal to 8.10.0.

Future Implementation

• Webhooks / Event Implementation
• Renaming Title

Testing

Accuser uses Mocha for unit testing. To perform testing:

• Ensure that development dependencies are installed.
• Run the following command npm test.

Contributing

To make changes:

• Follow Airbnb's JavaScript Style Guide at here.
  • In this project, we use the eslint-config-airbnb-base preset and make reasonable adjustments in .eslintrc.js.
• 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 master branch via pull requests (preferred), direct commits, etc.
• Update the version defined in package.json. Please use semantic versioning.
• Create a new release using the new version you defined just now.
• Ask any project member with required privileges to sync the release branch with the master branch
  • To make the Git history clean, a Git rebase is preferred over merge.
• Switch to the release branch and create a tag named as the new version you defined.
• Push the changes (as well as the new tag) to GitHub.

License

MIT License