OASIS
Open Algebra Software
|
Pull requests, new issues, bug reports, and any other kinds of contribution are welcome and encouraged!
For contributing to the project, please follow our pull request workflow:
feature-dividing-expressions
.feature
for adding, removing, or modifying a featurebugfix
for fixing bugsdoc
for writing documentationworkflow
for working with software workflows, like GitHub Actions or CMakeworkflow-new-action-for-clang-format
, use workflow-clang-format
.master
branch. If you ever find youself needing to pull in new changes into your branch, consider rebasing your branch.Format CMake
workflow on your working branch.master
branch. For the subject line of the pull request, follow our naming convention. Make sure that all CI/CD runs pass. If there are merge conflicts, you are reponsible for resolving them. If you need help, please feel free to reach out to one of the project maintainers for assistance.master
branch, you can sync your fork by pulling from upstream. You can delete your working branch as well.We adopt a standard naming convention for pull request subject lines. Here are some guidelines:
Add integration
instead of Adds integration
or Adding integration
).[Feature] Add Logarithms
or [Doc] Improve CONTRIBUTING.md
).We strive to follow WebKit's coding style guidelines. Additionally, we use clang-format
to keep the formatting of our C++ code consistent. Here are some additional guidelines this project follows:
When it comes to coding style, consistency is extremely important. Be sure to follow the existing style, format, and naming convention in the file(s) you are modifying. This is also enforced by GitHub Actions workflows. Unfortunately, this is not as automatic as we'd like. To run these workflows, you need to manually run them from GitHub.
In the diagram, origin/master
is the master
branch of the upstream repository. The branches feature-dividing-expressions
and workflow-clang-format
are branches on a developer's fork. Each dot on the diagram represents a commit or merge, labeled with a unique identifier.