Skip to content

Latest commit

 

History

History
42 lines (32 loc) · 2.29 KB

CONTRIBUTING.md

File metadata and controls

42 lines (32 loc) · 2.29 KB

Contributing Guidelines

Thank you for your interest in contributing to torch-fem! To maintain a smooth workflow, please follow these steps to collaborate using forks and pull requests.

🛠 How to Contribute

  1. Fork the Repository: Click the "Fork" button at the top right of this repository to create a copy under your GitHub account.
  2. Clone Your Fork: Clone your forked repository to your IDE
  3. Create Branch: Create a branch from the main branch.
  4. Develop: After making changes, commit them with a meaningful message, and push the changes to your forked repository.
  5. Create a Pull Request (PR): When ready, head back to this repo on Github, click on "Pull Requests" and select "New Pull Request". Choose your forked branch and submit the PR.

✅ Guidelines for Pull Requests

  • Ensure your code follows the project's coding standards.
  • Keep PRs focused on a single topic.
  • Write meaningful commit messages.
  • Update documentation or tests if applicable.
  • Ensure your changes do not break existing functionality.

💬 Need Help?

If you have any questions or need clarification, feel free to open an issue or reach out.

Thank you for contributing! 🎉

Contributing to torch-fem

Thank you for considering contributing to torch-fem! We appreciate your time and effort. Here’s a quick guide to help you get started.

Reporting Issues

  • If you find a bug or have a feature request, please open an issue in the Issues section.
  • Provide as much detail as possible (screenshot, minimal working example, etc.) to help us understand and reproduce the issue.

Making Changes

  1. Fork the repository: Create your own fork of the repo by clicking "Fork" at the top right of the project page.
  2. Commit changes in your personal fork: Ensure your commit messages are clear and descriptive.
  3. Test your changes: If applicable, run the existing tests and add new ones if you’ve introduced new functionality.
  4. Submit a Pull Request (PR): Go to the main repository and click "New Pull Request." Provide a description of your changes and reference any related issue numbers.

Code Style

  • Follow the black coding style for Python.
  • Keep code clean and modular.
  • Use type annotations.