Thank you for your interest in contributing to the OOFEM project! We welcome contributions in various forms, including bug fixes, new features, documentation improvements, and more. To ensure a smooth collaboration, please follow these guidelines:
-
Fork the repository to your own GitHub account.
-
Clone the forked repository to your local machine.
-
Set up your development environment by following the instructions in the project README.
-
Development Branch: All pull requests should be made to the devel branch. This branch serves as the working branch for ongoing development and new contributions.
-
Master Branch: The master branch is reserved for releases only. Do not push or merge changes directly into this branch.
-
Before starting your work, ensure that your local repository is up-to-date with the devel branch.
-
Create a new branch from devel for your contributions (e.g., feature/new-functionality or bugfix/issue-123).
-
Ensure your code follows the project’s coding standards and is well-documented.
-
Test your changes thoroughly before submitting the pull request.
-
Create a pull request against the devel branch in the main repository. Provide a clear and descriptive title and include the following information in the pull request description:
-
A summary of changes.
-
The reason for the changes.
-
Any relevant issue numbers.
-
Update relevant documentation.
-
Add tests (if applicable).
-
-
All pull requests will be reviewed by the maintainers.
-
Be responsive to feedback and make necessary changes promptly.
-
Once approved, your changes will be merged into the devel branch.
-
If you encounter a bug or have a feature request, please create an issue in the GitHub repository.
-
Provide a detailed description, steps to reproduce (if applicable), and any relevant information.
Feel free to let me know if you’d like to tweak anything or add additional sections!