CONTRIBUTING.md

Contributing to ForCAD

Contributions to ForCAD are welcome and thankds for taking the time to contribute to ForCAD!

Table of Contents

• Contributing to ForCAD
  • Table of Contents
  • How to Contribute?
    • Reporting Issues
    • Suggesting Enhancements
    • Implementing Changes and Adding Features
    • Sharing Examples
  • Styleguides
    • Code Style
    • Documentation
    • Git Commit Messages

How to Contribute?

Reporting Issues

If you encounter any problems, please open an issue on GitHub. Be sure to include detailed information about the issue.

Suggesting Enhancements

Do you have ideas for improving ForCAD? please open an issue on GitHub and describe your proposed enhancements in detail.

Implementing Changes and Adding Features

If you'd like to add new features, fix bugs, or enhance existing functionality, consider submitting a pull request (PR). Here's how to proceed:

1. Fork the repository and create a new branch from main to work on your changes.
2. Implement your modifications and enhancements.
3. Ensure that your code adheres to the project's coding style and guidelines.
4. Write clear and descriptive commit messages.
5. Submit your PR with an explanation of the changes introduced.

Sharing Examples

Contribute to ForCAD by submitting a pull request (PR) with examples. Ensure that your examples are documented.

Styleguides

Code Style

• Maintain consistency with the existing code style and structure.
• Write clear, concise, and well-commented code.
• Thoroughly test your changes before submission.

Documentation

• Follow the FORD documentation styles for documentation.

Git Commit Messages

• Limit the first line to 72 characters or fewer.
• Include references to issues and pull requests in the first line.
• Use the present tense ("Fix bug" not "Fixed bug")
• Use the imperative mood ("Add feautre to..." not "Adds feautre to...")