Anzu

# Contributing

Anzu is completely open source and contribution to this tool is highly encouraged for everyone! If you have found any issues during your usage of this program, please submit an issue and I'll go back to you right away.

In order to contribute to this project as a programmer, please follow these style guide and workflow.

# Project Structure

The project is structured as follows (top-level only):

  • .circleci for CircleCI pipeline integration.
  • .github for repository related files.
  • auto for the automatic ping script (CRON).
  • constants for Anzu configuration variables.
  • functions to store the essential functions.
  • models to store NoSQL data models.
  • responses to store Anzu's responses.
  • routes to process Anzu's commands.
  • types for custom types.
  • utils for utility functions.

# Coding Style Guide

Please follow this for the sake of the code to be as readable and maintainable as possible.

  • Use your best spelling and punctuation, in English.
  • Before you submit your pull request, ensure that you run the following procedures.
npm run format
npm run lint
  • It is done so that the code style remains consistent throughout the whole repository. For your information, my ESLint configuration uses Airbnb style.

# Commit Style Guide

Please use Semantic Commit Messages (opens new window), but with past tense and first letter capitalized. For further details, please check this gist (opens new window) and this website (opens new window). Using these kinds of commit messages will make contributors into better programmers because of its rigid style. Another reason of using it is because its rigid style actually forces contributors to not commit lots of files in one setting.

# Note About Anzu Replying

If you want to add a feature that makes Anzu reply to the users, please insert the output message (in the file format of functionName.txt) in the responses/functionsFileName folder (taskFunctions will be named as tasks, plural). Make sure that the function name is the same as the file output name.

If you need to insert dynamic messages, use the provided transformResponse function in utils/responseHelper.ts and prepare a template in the file like I did with <%MESSAGE(NUMBER_STARTS_FROM_ZERO)%>. Note that you should insert an empty array if you do not need to insert dynamic messages.

// Static message example.
const message = transformResponse('functionName', []);
const response = createResponse(message);
await client.replyMessage(replyToken, response);

// Dynamic message example.
const message = transformResponse('functionName', ['string1', variableOne]);
const response = createResponse(message);
await client.replyMessage(replyToken, response);

Note that the items in the array are processed (replaced) sequentially.

# Workflow

In order to contribute to this project, please create an issue about the problem that you are going to fix / add. After that, follow these instructions below.

  • Fork the repository.
  • Create a new branch based on the issue number that you created beforehand. Example: git checkout -b 10.
  • Make sure to update the CHANGELOG.md, the version number in package.json, and version number in the badge in the README.md file.
  • Make sure to update the documentation (if possible) if you add or edit any responses and/or functions.
  • Commit and push your features / changes.
  • Create a new pull request.

← Changelog →