VOLTTRON is an Eclipse Foundation project. If this is your first time contributing to an Eclipse Foundation project, you'll need to sign the Eclipse Contributor Agreement.
-
Create an account on dev.eclipse.org
-
Open your Account Settings tab
-
Edit your profile
enter your GitHub ID under the "Social Media Links" section and click save.
-
-
Read and sign the Eclipse Contributor Agreement
-
Use the exact same email address for your Eclipse account and your commit author.
Search the issue tracker for a relevant issue or create a new one.
Fork the repository in GitHub and make changes in your fork.
Submit a pull request.
Join the mailing list or email [email protected] to discuss your ideas and get help.
VOLTTRON version numbers follow Semantic Versioning. This means we increment the major version when we make incompatible API changes. This includes any changes which:
- break source compatibility (i.e. changing a function such that current code breaks)
- break serialization compatibility (i.e. changing the VIP protocol over the message bus.)
- Use the imperative mood as in "Fix bug" or "Add feature" rather than "Fixed bug" or "Added feature"
- Mention the GitHub issue when relevant
- It's a good idea to follow the advice in Pro Git
- Good commit messages are critical for maintainability of the project.
Excessive branching and merging can make git history confusing. With that in mind
- Squash your commits down to a few commits, or one commit, before submitting a pull request
- Rebase your pull request changes on top of the current main. Pull requests shouldn't include merge commits.
Submit your pull request when ready. Three checks will be kicked off automatically.
- IP Validation: Checks that all committers signed the Eclipse CLA and signed their commits.
- Continuous integration: GitHub Actions that run pytests and CodeQL.
- The standard GitHub check that the pull request has no conflicts with the base branch.
Make sure all the checks pass. One of the committers will take a look and provide feedback or merge your contribution.
That's it! Thanks for contributing to VOLTTRON!