Skip to content

Latest commit

 

History

History
40 lines (27 loc) · 1.6 KB

CONTRIBUTING.md

File metadata and controls

40 lines (27 loc) · 1.6 KB
Raw

Contributing

Thank you for considering contributing to our project!

New to contributing? Check out this free series How to Contribute to an Open Source Project on GitHub to learn how.

Contact the team

If you want to discuss AutoVizuA11y in greater depth, or contribute to the project, contact us through data-viz@feedzai.com.

Project Setup

  1. Fork and clone the repository.
  2. Run $ npm install to install dependencies.
  3. Create a new branch for your pull request (PR).

Tip: Keep your main branch synchronized with the original repository. To set this up, run:

git remote add upstream https://github.com/feedzai/AutoVizuA11y
git fetch upstream
git branch --set-upstream-to=upstream/master main

This ensures that your main branch tracks the upstream repository's master branch, facilitating easier updates. Base your pull request branches on this main branch.

Test your changes

Before committing your changes, ensure all tests pass by running npm run test.

Assistance Required

Check out the open issues for tasks that need assistance. Please follow one of the provided templates when adding an issue to this repository.

Also, please consider watching the repository and actively participating in discussions, responding to questions, bug reports, and feature requests. Your engagement is appreciated!