It means so much that you're interested in contributing to Caley.io! Seriously. Thank you. The entire community benefits from these contributions!
- Before contributing, please check if it already exists in issues or PRs
- Given the speed at which we're moving on the codebase, we don't assign issues or "give" issues to anyone.
- When multiple PRs are submitted for the same issue, we take the one that most succinctly & efficiently solves a given problem and stays within the scope of work.
- Priority is generally given to previous committers as they've proven familiarity with the codebase and product.
As we are still in the early days of this project, we recommend heading over to the Wiki to get a better idea of what to contribute.
In general, full features that get us closer to our Vision are the most valuable contributions at this stage.
To get setup for local development, you have two options:
- Dev Containers with VSCode (see the
.devcontainer
folder) - Local Development
- Fork the repo
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create new Pull Request, and be sure to check the Allow edits from maintainers option while creating your PR. This allows maintainers to collaborate with you on your PR if needed.
- If possible, link your pull request to an issue by adding the appropriate keyword (e.g.
fixes issue #XXX
) - Before requesting a review, please make sure that all Github Checks have passed and your branch is up-to-date with the
main
branch. After doing so, request a review and wait for a maintainer's approval.
All PRs should target the main
branch.