diff --git a/CHANGELOG.md b/CHANGELOG.md index 359a38e19..2c8879872 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,4 +8,6 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), ### Added -- Added `CHANGELOG.md` file. \ No newline at end of file +- Added `CHANGELOG.md` file. +- Added `CONTRIBUTING.md` file. +- Updated `README.md` file. \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..72971f49b --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,59 @@ +# Contributing to ForCAD + +Contributions to ForCAD are welcome and thankds for taking the time to contribute to ForCAD! + +## Table of Contents +- [Contributing to ForCAD](#contributing-to-forcad) + - [Table of Contents](#table-of-contents) + - [How to Contribute?](#how-to-contribute) + - [Reporting Issues](#reporting-issues) + - [Suggesting Enhancements](#suggesting-enhancements) + - [Implementing Changes and Adding Features](#implementing-changes-and-adding-features) + - [Sharing Examples](#sharing-examples) + - [Styleguides](#styleguides) + - [Code Style](#code-style) + - [Documentation](#documentation) + - [Git Commit Messages](#git-commit-messages) + +## How to Contribute? + +### Reporting Issues + +If you encounter any problems, please [open an issue](https://github.com/gha3mi/forcad/issues) on GitHub. Be sure to include detailed information about the issue. + +### Suggesting Enhancements + +Do you have ideas for improving ForCAD? please [open an issue](https://github.com/gha3mi/forcad/issues) 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](https://forddocs.readthedocs.io/en/latest/user_guide/writing_documentation.html) 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...") \ No newline at end of file diff --git a/README.md b/README.md index af213e136..b3036d311 100644 --- a/README.md +++ b/README.md @@ -84,11 +84,7 @@ For a detailed roadmap outlining upcoming features and enhancements, please refe ## Contributing -Contributions to ForCAD are welcome! - -- If you find any issues or would like to suggest improvements, please open an issue. -- If you've implemented new features, fixed bugs, or enhanced existing functionality, please consider submitting a pull request (PR). -- Please share your examples by submitting a pull request (PR). +To contribute to ForCAD, please review the [CONTRIBUTING.md](https://github.com/gha3mi/forcad/blob/main/CONTRIBUTING.md). ## Citation