Thank you for your interest in the Celeritas project! Although Celeritas is developed primarily by a group of U.S. Department of Energy subcontractors, our goal is to increase community involvement and integration over time. We welcome your contributions!
All submissions to the Celeritas project are automatically licensed under the terms of :ref:`the project copyright <code_copyright>` as formalized by the GitHub terms of service. The person who writes a line of code is its author and copyright holder, but the new code should be the shared responsibility of the project rather than the exclusive property of a single contributor. Celeritas is a collaborative project with collective ownership.
Working with other Celeritas team members is a critical part of the development
process. Please join the #code channel on the Celeritas Slack workspace,
open an issue with a bug report or feature request, or start a discussion on
GitHub.
Create a fork of the Celeritas repository. You should clone this fork locally
to your development machine as the "origin", and it's a good idea to add the
main celeritas-project repository as an "upstream" so that you can apply
changes from the main codebase as you work.
To meet the :ref:`formatting` requirements described in the development guide,
make sure that clang-format is installed on your development machine.
Run scripts/dev/install-commit-hooks.sh to install a git post-commit hook
that will amend each commit with clang-format updates if necessary.
A mostly consistent set of decorations (separators, Doxygen comment structure,
etc.) are used throughout the code, so try to make new files look like existing
ones. Use the celeritas-gen.py script (in the scripts/dev directory) to
generate skeletons for new files, and use existing source code as a guide for
how to structure the decorations.
When you believe that you've made a substantive [subst] and self-contained improvement to the code, it's time to create a pull request (PR) to get feedback on your changes before they're merged into the code base. The pull request should be as close to a "single change" as possible (i.e., the short pull request title can essentially describe the entire change set), typically a few hundred lines (not including tests and test data). A pull request could be as small as a single line for a bug fix. If your changes involve both substantial refactoring and new features, try to split the refactoring into a separate commit.
Before opening the pull request, check that the :ref:`code <code_guidelines>` and :ref:`style <style_guidelines>` guidelines have been followed for all new code and code changes. Ensure the use of the correct formatting as well as the addition of documentation and unit tests for new code and bug fixes.
All tests must pass on the CI runner before a PR can be merged. It's best to test locally first before submitting your pull request, and keep in mind that the multiple configurations on the CI (different dependency versions, different features) may reveal failures that your local testing might have missed.
Each pull request should be assigned one or two reviewers who will provide constructive feedback on your changes. Their responsibilities are outlined in :ref:`code_review`. Reviews should not be started until the "draft" status has been removed (if you marked it as a draft initially). Once a pull request is under review, do not rebase, squash, or otherwise alter the branch history. Such changes can drastically increase the difficulty of reviewing, because it may blend in a single commit both changes in response to a review and changes from upstream code. (Furthermore, it breaks GitHub notifications and makes it more difficult to find older comments.) You can merge the main upstream branch if your changes may interact with the upstream changes, and you must merge if they conflict.
The review is complete and your branch will be squashed and merged when:
- All the CI tests pass,
- All conversations have been resolved [resol], and
- The reviewer has approved the changes.
And you will officially be a Celeritas :ref:`contributor <roles>`! Congratulations!
| [subst] | All changes to the codebase must go through the pull request, but due to the overhead of reviewing, testing, merging, and documenting a PR, we'd like to avoid small changes that have almost no effect in terms of operation or readability. For example, if you find a typo in the documentation, check the rest of the docs for any other typos or improvements you'd like to make, and submit a single PR with those changes. |
| [resol] | When you've fully implemented the reviewer's comment, you may mark it as resolved without commenting. Do not resolve a conversation if you disagree with the feedback: instead, post your view in a follow-on comment and wait for the reviewer to respond. If you comment, whether to supplement your change or to iterate with the reviewer, please do not resolve the conversation since that makes it hard to find your comment. |