How to contribute to OrcaMap

Great! Please review https://github.com/orcasound/orcagsoc/issues and our repo's Issues
On Slack, prefer group communication. Please do not DM Ivan or project leads directly, post questions and ideas in #orcamap-react so that the group is aware of movement on the project

Please make sure you review the #orcamap-react channel history
Post what you would like to work on in the channel and Github issues and make sure others are not already working on it
Post in the #orcamap-react channel when you have begun work
Your branch name and commit messages should follow conventional commits standards - no generic names like 'dev'. Use npm run commit to use commitizen to help name commits
Your PR should show up in #orcamap-react automatically from the Github bot

It's all about clear and detailed communication in the group. This is a self-organizing group, so communication is key.

Instead of thinking of a PR as "here's all the work I did today" Please limit your PR to one topic or unit of code. This makes PRs smaller, easier to review, and easier to merge
Tag other contributors for review on your PR
Include tests if possible

Do not open up a GitHub issue if the bug is a security vulnerability in Orcamap, and instead to refer to our security policy.
Ensure the bug was not already reported by searching on GitHub under Issues.
If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

Open a new GitHub pull request with the patch.
Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.

Orcasound and Orcamap are a volunteer effort. We encourage you to pitch in and join the team!

Thanks! ❤️ ❤️ ❤️

Orcamap Team

Provide feedback