Contribute
Contribute to the open-source development of OpenSees.
OpenSees is fully open source and welcomes any contribution. To streamline the contribution process, please take a moment to review the guidelines outlined in this article.
The issue tracker on GitHub is the preferred channel for bug reports, feature requests and submitting pull requests.
Use the GitHub Discussions to ask for help from the OpenSees community . The discussion forum also includes other topics, such as ideas and showcases . We strive for a safe, welcoming, and productive community. The community guidelines provide more context about the expectations, moderation policy, and terms of service.
A bug is a demonstrable problem that is caused by the code in the repository. This may also include issues with the documentation or configuration files. Before filing a bug report, please consider the following guidelines:
Feature requests are welcome. Please use the provided template in the issue tracker to capture the idea and context.
Important
By submitting a patch, you agree to allow the project owners to license your work under the terms of the BSD license (if it includes code changes) and under the terms of the Creative Commons ( CC BY-NC 4.0) license (if it includes documentation changes).
Please adhere to the coding guidelines used throughout the project (indentation, accurate comments, etc.) and any other requirements (such as test coverage).
Adhering to the following process is the best way to get your work included in the project:
Fork the project, clone your fork, and configure the remotes:
git clone https://github.com/<your-username>/OpenSeesRT.git
cd OpenSeesRT
git remote add upstream https://github.com/claudioperez/OpenSeesRT
If you cloned a while ago, get the latest changes from upstream:
git checkout main
git pull upstream main
Create a new topic branch (off the main project development branch) to contain your feature, change, or fix:
git checkout -b <topic-branch-name>
Commit your changes in logical chunks. Please adhere to these git commit message guidelines . Use Git’s interactive rebase feature to tidy up your commits before making them public.
Locally merge (or rebase) the upstream development branch into your topic branch:
git pull [--rebase] upstream main
Push your topic branch up to your fork:
git push origin <topic-branch-name>
Open a Pull Request with a clear title and description against the main branch.
In general, run clang-format <your-file.cpp>
before committing to ensure your changes follow our coding standards.
By contributing your code, you agree to license your contribution under the BSD license . By contributing to the documentation, you agree to license your contribution under the Creative Commons ( CC BY-NC 4.0 ) license.