Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
65 lines (47 loc) · 1.88 KB

CONTRIBUTING.md

File metadata and controls

65 lines (47 loc) · 1.88 KB

Contributing to FEMFFUSION

Thank you for your interest in contributing to FEMFFUSION!
We welcome contributions from the community to improve the code, documentation, and examples.

How to Contribute

1. Fork the Repository

  • Click the Fork button at the top right of the main repository.
  • Clone your fork to your local machine: 
    git clone https://github.com/your-username/FEMFFUSION.git

2. Create a Branch

  • Create a new branch for your feature or bugfix: 
    git checkout -b my-feature

3. Make Your Changes

  • Make your changes in the code, documentation, or examples.
  • Please follow the existing code style and add comments where appropriate.

4. Test Your Changes

  • Ensure that your changes do not break existing functionality.
  • Run the test suite: 
    ./femffusion.exe -t
  • If you add new features, consider adding corresponding tests or examples.

5. Commit and Push

  • Commit your changes with a clear message: 
    git add .
git commit -m "Describe your changes"
git push origin my-feature

6. Open a Pull Request

  • Go to your fork on GitHub and click Compare & pull request.
  • Describe your changes and reference any related issues.

Code of Conduct

Please be respectful and constructive in your communications.
We value a welcoming and inclusive environment for all contributors.

Reporting Issues

If you find a bug or have a feature request, please open an issue and provide as much detail as possible.

Style Guidelines

  • Use clear, descriptive commit messages.
  • Follow the existing code formatting and naming conventions.
  • Document new functions and classes.

Questions?

For questions or help, contact anvifer2@upv.es or open an issue on GitHub.

Thank you for helping to improve FEMFFUSION!