Contributing 🎊

Contributions of any kind are welcome!

Types of contributions

There are many ways to contribute to the code and community:

• 🐛 Found a bug? ==> Create a bug report in the repo's issues page.
• ✨ Have an idea for a new feature? ==> Suggest it in the repo's issues page.
• ❓ Have a question? ==> Yep, ask in the repo's issues page. Anything from basic usage to more advanced questions.
• 📜 Help improve the documentation. Anything from small typos to new examples. Submit a pull request.
• 💬 Help answer other's questions in the repo's issues page.
• 🛠 Contribute code through a pull request to address an open issue. Not sure where to start? ==> Look at good first issues.
• ❗Report violations to the community standard directly to us via email.
• 🚨 Identified a security vulnerability? ==> See the security policy.
• 👯 Want to collaborate on a project? ==> Contact us.

Community Standards 🌱 💜

Please adhere to the Contributor Covenant Code of Conduct and report any abuse. Remember that open source development is a social process and we are in this together.

• 💜 Be respectful and inclusive, everyone should feel welcomed.
• 🙏🏽 Give credit. Respect copyright right laws. Acknowledge others that have helped you.
• ❌ Any type of harrassment, including prejudiced or inapproriate comments and jokes or personal attacks, will not be tolerated.

Contributing changes 🛠️

Contribute changes, including code and documentation, through pull request.

New contributors: While it is important for a project to have well defined practices, don't feel like you need to read/understand all of it right away! At the very minimum, follow the GitHub Flow and start with a draft pull request. We can work from there together! 🤓

Development practices:

• Use the GitHub Flow.
• Follow the ColPrac guide for collaborative practices.
• Follow the SciML style guide 😎.
• Use the Conventional Commits to title pull requests.
• Familiarize yourself with the source code, documentation, testing, and CI in the repo, and update the documentation and testing when appropriate.
• Know that your submissions are understood to be under the same license that covers the project. Feel free to contact us if that's a concern.

Repo-Specific URLs: Replace <repo-name> with the repo's name.

• issues page: github.com/JuliaOceanWaves/<repo-name>/issues
• pull request: github.com/JuliaOceanWaves/<repo-name>/pulls
• good first issue: github.com/JuliaOceanWaves/<repo-name>/contribute
• security policy: github.com/JuliaOceanWaves/<repo-name>/security
• license: github.com/JuliaOceanWaves/<repo-name>/LICENSE.md