Welcome to Orcasound! We're thrilled you're interested in contributing to the site.
Please read and make sure you understand our Code of Conduct before contributing to the project.
First, ensure the bug was not already reported by searching on GitHub under Issues.
If you found a bug, you can help us by submitting a GitHub Issue. The best bug reports provide a detailed description of the issue and step-by-step instructions for reliably reproducing the issue.
You can request a new feature by submitting a GitHub Issue.
If you would like to implement a new feature, please first submit a GitHub Issue and communicate your proposal so that the community can review and provide feedback. Getting early feedback will help ensure your implementation work is accepted by the community. This will also allow us to better coordinate our efforts and minimize duplicated effort.
The Notification System is currently covered by the MIT License.
If you are willing to follow the conditions of this license, check out the following link to find an unassigned item to contribute to:
Once you've chosen an issue and want to contribute code:
- Fork the aifororcas-livesystem repo.
- Develop on a feature branch.
- Submit a PR (don't review your own)!
For all but the absolute simplest changes, first find an existing GitHub issue or submit a new issue so that the community can review and provide feedback. Getting early feedback will help ensure your work is accepted by the community. This will also allow us to better coordinate our efforts and minimize duplicated effort.
If you would like to contribute, first identify the scale of what you would like to contribute. If it is small (grammar/spelling or a bug fix) feel free to start working on a fix. If you are submitting a feature or substantial code contribution, please discuss it with the maintainers and ensure it follows the public roadmap. You might also read these two blogs posts on contributing code: Open Source Contribution Etiquette by Miguel de Icaza and Don't "Push" Your Pull Requests by Ilya Grigorik. All code submissions will be reviewed and tested, and only those that meet the bar for both quality and design/roadmap appropriateness will be merged into the source.
For all pull requests the following rules apply:
- The pull request description should describe the problem and solution, and reference the GitHub issue if one exists.
- Existing tests should continue to pass.
- Tests should ideally be included for every bug or feature that is completed.
- Documentation should be updated for every feature that is end-user visible.
- Coding style should be consistent with the style used in other files of the same type in this repository.
We are happy to answer as best we can any question you have about the NotificationSystem. There are multiple ways you can ask questions:
- Using the Zulip channel
- Using Github discussions