Skip to content

Commit 7c69457

Browse files
Create CONTRIBUTING.md
1 parent aab03a4 commit 7c69457

File tree

1 file changed

+73
-0
lines changed

1 file changed

+73
-0
lines changed

CONTRIBUTING.md

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
# Contributing to MEDICS Software
2+
3+
First of all, thank you for considering contributing to **MEDICS Software**! We are excited to have contributors like you who help make this project better. To make the process smoother, please follow these guidelines:
4+
5+
## Table of Contents
6+
- [Code of Conduct](#code-of-conduct)
7+
- [How to Contribute](#how-to-contribute)
8+
- [Issues](#issues)
9+
- [Pull Requests](#pull-requests)
10+
- [Code Style](#code-style)
11+
- [Testing](#testing)
12+
13+
## Code of Conduct
14+
15+
We have a [Code of Conduct](CODE_OF_CONDUCT.md) that we expect all contributors to follow. Please be respectful, kind, and considerate in your interactions.
16+
17+
## How to Contribute
18+
19+
Contributions to this project are always welcome! Here’s a simple process you can follow to contribute:
20+
21+
1. **Fork** the repository.
22+
2. **Clone** your fork to your local machine.
23+
3. Create a **new branch** for your changes:
24+
- For features: `feature/<your-feature-name>`
25+
- For bug fixes: `bugfix/<your-bugfix-name>`
26+
4. Make your changes and **commit** them with a clear and concise message.
27+
5. Push your changes to your fork on GitHub.
28+
6. **Open a Pull Request (PR)** to the main repository with a description of your changes.
29+
30+
## Issues
31+
32+
- **Bug reports** and **feature requests** are always appreciated. If you find a bug, please open a new issue and provide as much information as possible:
33+
- A clear and concise title.
34+
- A description of the problem and steps to reproduce it.
35+
- Relevant screenshots or logs (if applicable).
36+
- The version of the software or platform you are using.
37+
38+
- If you're submitting a **feature request**, be sure to explain the problem it solves and why you think the feature is beneficial.
39+
40+
## Pull Requests
41+
42+
When submitting a pull request:
43+
44+
1. Ensure your changes are **tested** and meet the guidelines in this document.
45+
2. Provide a **detailed description** of your changes in the PR message.
46+
3. If your pull request resolves an issue, reference the issue number in the description (e.g., "Fixes #42").
47+
4. **Do not submit** a pull request with uncommitted changes. Make sure your branch is up-to-date with the latest `main` branch before submitting.
48+
49+
## Code Style
50+
51+
Please follow these code style guidelines to ensure consistency:
52+
53+
- **Use descriptive names** for variables, functions, and classes.
54+
- **Indent with spaces**, not tabs (2 spaces for each level).
55+
- Keep line length under **80 characters**.
56+
- **Avoid redundant code** and try to use existing functions where possible.
57+
- **Use comments** where necessary to explain complex code or logic.
58+
59+
## Testing
60+
61+
Before submitting any changes, please ensure that:
62+
63+
1. All **unit tests** pass.
64+
2. If you’ve added a new feature or fixed a bug, please add **tests** that cover your changes.
65+
3. **Run the tests** locally before submitting your pull request to ensure that everything works as expected.
66+
67+
## Documentation
68+
69+
If your changes affect the documentation, please make sure to update the relevant sections in the `README.md` or other relevant files.
70+
71+
## Thank You!
72+
73+
Thank you for your contribution to **MEDICS Software**. We appreciate your help in making this project even better!

0 commit comments

Comments
 (0)