Skip to content

Latest commit

 

History

History
80 lines (56 loc) · 5.97 KB

CONTRIBUTING.md

File metadata and controls

80 lines (56 loc) · 5.97 KB

Contributing to annyang

Thank you for taking the time to get involved with annyang! 👍

There are several ways you can help the project out:

How Can I Contribute?

Contributing Code

A lot of annyang's functionality came from pull requests sent over GitHub. Here is how you can contribute too:

  • Fork the repository from the annyang GitHub page.

  • Clone a copy to your local machine with $ git clone [email protected]:YOUR-GITHUB-USER-NAME/annyang.git

  • Make sure you have node.js and pnpm installed on your machine.

  • Install all of annyang's development dependencies with pnpm. $ cd annyang; pnpm install

  • Run the tests to make sure everything runs smoothly: $ pnpm test

  • Add tests for your code. See details below.

  • Code, code, code. Changes should be done in /src/annyang.ts.

  • Run $ pnpm test and $ pnpm lint after making changes to verify that everything still works and the tests all pass.

    💡 A great alternative to repeatedly running tests is to run $ pnpm test:watch once, and leave this process running. It will continuously run all the tests every time you make a change to one of annyang's files. 👍

  • Before committing your changes, the last step must always be running $ pnpm test and $ pnpm lint. This makes sure everything works.

  • Once you've made sure all your changes work correctly and have been committed, push your local changes back to github with $ git push -u origin master

  • Visit your fork on GitHub.com (https://github.com/YOUR-USER-NAME/annyang) and create a pull request for your changes.

  • Makes sure your pull request describes exactly what you changed and if it relates to an open issue references that issue (just include the issue number in the title like this: #49)

Important:

  • Make sure to run pnpm install, pnpm test, and pnpm lint and make sure all tasks completed successfully before committing.
  • Do not change the API docs in /docs/README.md directly. This file is generated automatically, and your changes will be overwritten. Instead, update the relevant comments in src/annyang.ts
  • Do not update the version number yourself.
  • Please stick to the project's existing coding style. Coding styles don't need to have a consensus, they just need to be consistent 😄.
  • Push your changes to a topic branch in your fork of the repository. Your branch should be based on the master branch.
  • When submitting pull request, please elaborate as much as possible about the change, your motivation for the change, etc.

Build Commands

Command Description
pnpm build Build ESM, CJS, and IIFE bundles with tsup
pnpm test Run tests with Vitest
pnpm test:watch Run tests in watch mode
pnpm lint Run ESLint
pnpm format Format code with Prettier
pnpm typecheck Check types with TypeScript
pnpm dev Build in watch mode

Automated Testing

annyang is tested using Vitest.

Please include tests for any changes you make:

  • If you found a bug, please write a test that fails because of that bug, then fix the bug so that the test passes.
  • If you are adding a new feature, write tests that thoroughly test every possible use of your code.
  • If you are changing existing functionality, make sure to update existing tests so they pass. (This is a last resort move. Whenever possible try to maintain backward compatibility)

To simulate Speech Recognition in the testing environment, annyang uses a mock object called Corti which mocks the browser's SpeechRecognition object. Corti also adds a number of utility functions to the SpeechRecognition object which simulate user actions (e.g. say('Hello there')), and allow checking the SpeechRecognition's status (e.g. isListening() === true).

Reporting Bugs

Bugs are tracked as GitHub issues. If you found a bug with annyang, the quickest way to get help would be to look through existing open and closed GitHub issues. If the issue is already being discussed and hasn't been resolved yet, you can join the discussion and provide details about the problem you are having. If this is a new bug, please open a new issue.

When you are creating a bug report, please include as many details as possible.

Explain the problem and include additional details to help maintainers reproduce the problem.

  • Use a clear and descriptive title for the issue to identify the problem.
  • Describe the exact steps which reproduce the problem. Share the relevant code to reproduce the issue if possible.
  • Try to isolate the issue as much as possible, reducing unrelated code until you get to the minimal amount of code in which the bug still reproduces. This is the most important step to help the community solve the issue.

Feature Requests and Ideas

We track discussions of new features, proposed changes, and other ideas as GitHub issues. If you would like to discuss one of those, please first look through existing open and closed GitHub issues and see if there is already a discussion on this topic which you can join. If there isn't, please open a new issue.

When discussing new ideas or proposing changes, please take the time to be as descriptive as possible about the topic at hand. Please take the time to explain the issue you are facing, or the problem you propose to solve in as much detail as possible.