CONTRIBUTING.md

Contributing

🎉 Thanks for taking the time to contribute! 🎉

The following is a set of guidelines for contributing to this repo. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document.

Table Of Contents

Code of Conduct

What should I know before I get started?

• GNU Make and Bash

How Can I Contribute?

• Reporting Bugs
• Suggesting Enhancements
• Your First Code Contribution
• Pull Requests

Styleguides

• Commit Messages
• Code Styleguide

Code of Conduct

This project and everyone participating in it is governed by our Code of Conduct. By participating, you are expected to uphold this code.

What should I know before I get started?

• Makefiles
• Bourne Again Shell
• Typescript
• Jest Test Framework

How Can I Contribute?

Reporting Bugs

Create a bug report issue

Suggesting Enhancements

Create a feature request issue

Your First Code Contribution

Local development

Install dependencies using the package node version.

[react-mirror]$ nvm use
[react-mirror]$ npm i -g pnpm
[react-mirror]$ pnpm i

Testing

NPM package source code is located in ./src with tests in the same folder.

Add jest style tests for new changes.

[react-mirror]$ pnpm test

Validating

After setup, build changes to NPM package source code, then run demo app to validate local dev react-mirror.

[react-mirror]$ pnpm build
[react-mirror]$ cd ./demo 
[react-mirror/demo]$ make start

NOTE: Use pnpm build-watch instead to watch code changes when in active development.

Pull Requests

After validating your changes and adding tests, push commits to a new branch and create a pull request using the provided GitHub template.

Styleguides

Commit Messages

Package using semantic commits convention.

git commit -m "fix: that one bug" -m "implementation details"

See the link above or commits in the repo for more examples.

Code Styleguide

Post install gives you access to the linter and static type checker.

[react-mirror]$ pnpm lint
[react-mirror]$ pnpm typecheck