Hi there! We're excited to have you as a contributor.
Have questions about this document or anything not covered here? Please file an issue at https://github.com/ansible/eda-server-operator/issues.
- All code submissions are done through pull requests against the
mainbranch. - All PRs must have a single commit. Make sure to
squashany changes into a single commit. - Take care to make sure no merge commits are in the submission, and use
git rebasevsgit mergefor this reason. - If collaborating with someone else on the same branch, consider using
--force-with-leaseinstead of--force. This will prevent you from accidentally overwriting commits pushed by someone else. For more information, see git push --force-with-lease. - We ask all of our community members and contributors to adhere to the Ansible code of conduct. If you have questions, or need assistance, please reach out to our community team at codeofconduct@ansible.com.
See docs/development.md for prerequisites, build/deploy instructions, and available Makefile targets.
For faster iteration, you can also run the EDA Operator roles directly on your local machine. See the Debugging docs for details.
- From your fork's
mainbranch, create a new branch to stage your changes.
git checkout -b <branch-name>- Make your changes.
- Test your changes (see Testing below).
- Commit your changes.
git add <FILES>
git commit -m "My message here"- Create your pull request.
Note: If you have multiple commits, make sure to
squashthem into a single commit before submitting.
All changes must be tested before submission:
- Linting (required for all PRs):
make lint - See the Testing section in docs/development.md for details on running tests locally.
We welcome your feedback, and encourage you to file an issue when you run into a problem at https://github.com/ansible/eda-server-operator/issues.
Join the Ansible Forum for questions, help, and development discussions. Search for posts tagged with eda or start a new discussion.