CLAIRE: Contributing Guidlines
March 18, 2021 ยท View on GitHub
Go back to README.md.
Content
- Overview
- Reporting Bugs and Issues
- Feature Requests
- Contributing to CLAIRE
- Testing and Benchmarks
- Coding Conventions
Overview
We welcome all contributions to CLAIRE. Contributions can be in the form of new code functions, improvements to the documentation, or by pointing out a bug or potential improvement. For general questions or requests, you can contact Andreas Mang by email: andreas [at] math [dot] uh.edu.
This project and everyone participating in it is governed by the code of conduct found in doc/CODE_OF_CONDUCT.md. By participating, you are expected to uphold this code. Please report unacceptable behavior to Andreas Mang.
Reporting Bugs and Issues
Bugs and issues can be reported at https://github.com/andreasmang/claire/issues. Before submitting a ticket, make sure the bug has not already been reported by searching existing issues on GitHub under issues. We also list some known issues in doc/README-INSTALL.md.
If you are reporting a bug or an issue, please include detailed information to help maintainers reproduce the problem.
Feature Requests
Additional features can be requested at https://github.com/andreasmang/claire/issues. Before submitting a feature request, make sure the feature has not already been requested by searching existing issues on GitHub under issues.
Contributing to CLAIRE
To contribute to the software:
- Fork the repository.
- Clone the forked repository, add your contributions and push the changes to your fork.
- Create a pull request.
Testing and Benchmarks
We have implemented several tests to check the accuracy of our numerical implementation. These are described in more detail in doc/README-RUNME.md.
Coding Conventions
Our source code follows the Google C++ Style Guide. Please adhere to these coding conventions if you would like to contribute to CLAIRE. Notice that all our routines use the error mechanism implemented in PETSc. We strongly encourage all contributers to include this mechanism to make debugging easier. We have added tags to identify the major releases of our software (related mostly to publications for reproducability).