Contributing to Viron

We would like to encourage everyone to help and support this project by contributing.

We manage tasks using the GitHub Project where you can see which issue is in progress, is done, or has high priority.

How Can I Contribute?

Please submit a GitHub issue to report a bug. Before submitting one, try to make sure any issue similar to your's doesn't already exist.

Please submit a GitHub issue to suggest a enhancement.

We apply the monorepo architecture; see each workspace's README.md for details.

Use the npm command's option --workspace with a workspace name to execute workspace-specific npm scripts, like:

$ npm run develop --workspace=@viron/app
$ npm run build --workspace=@viron/app --workspace=@viron/lib

Use the --workspaces option to execute a npm script on each workspace.

$ npm run test --workspaces

Below is a quick guide to code contribution.

Fork and clone the repo to your local machine.
Create a new branch from develop with a meaningful name for the task you work on.
Setup by running: npm install . --legacy-peer-deps. (Important: npm version >= 7.9.0)
Do your work following the styleguide of each package; read the readme.md files in each package directory.
Add changelog intentions by running npm run changelog:intent.
Push your branch.
Submit a pull request to the upstream repository.

Follow this.

By contributing to this project, you agree to license your contribution under the MIT license.

Thank you all who have contributed to this project.

_fkei 🤔 💻	_cathcheeno 🤔 💻 🌍 📖 📝	_noritama 🤔 💻	_babarl 🎨	_MuuKojima 💻	_tosaka07 💻	_Jung0 💻
_{TakahisaKodama} 💻	_syama666 💻	_takoring 💻	_nezuu 💻	_ishikawa-pro 💻	_niwattitti 💻	_ejithon 🤔