We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
- Reporting a bug
- Discussing the current state of the code
- Submitting a fix
- Proposing new features
- Becoming a maintainer
We use github to host code, to track issues and feature requests, as well as accept pull requests.
Pull requests are the best way to propose changes to the codebase and we actively welcome your pull requests:
- Fork the repo and create your branch from
main. - If you've added code that should be tested via storybook or unit test, add tests.
- Ensure that eslint checks and storybook test suite passes.
- Issue that pull request!
- Let prettier and eslint to take care of the formatting
- Please make sure to add TSDoc comments wherever necessary
- Avoid using
anyas a type - Make sure that the code is easily readable and understandable
In short, when you submit code changes, your submissions are understood to be under the same MIT License that covers the project. Feel free to contact the maintainers if that's a concern.
- Changes to landing page will be automatically deployed to https://beyojar.com via AWS Amplify
- Mobile app changes will be manually verified before triggering a build via expo.dev
Report bugs using Github's issues
We use GitHub issues to track public bugs. Report a bug by opening a new issue; it's that easy!
Great Bug Reports tend to have:
- A quick summary and/or background
- Steps to reproduce
- Be specific!
- Give sample code if you can.
- What you expected would happen
- What actually happens
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
People love thorough bug reports. I'm not even kidding.
You can either create an issue or even reach me out directly via my personal email [email protected] or LinkedIn for any assistance or clarifications.