Skip to content

Commit fdb655f

Browse files
Basudev Bharat BhushanBasudev Bharat Bhushan
authored andcommitted
fix: update readme
1 parent 7093c0c commit fdb655f

File tree

1 file changed

+8
-50
lines changed

1 file changed

+8
-50
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,15 @@
11
# Contributing to Python FM DAPI Weaver
22

3-
43
Thank you for your interest in contributing to **Python FM DAPI Weaver**! This guide outlines the steps to get started and the standards we follow.
54

6-
7-
8-
## Ways to Contribute?
5+
## Ways to Contribute?
96

107
You can help improve the project in the following ways:
118

129
- **Bug Reports**: Identify and report any bugs you find.
1310
- **Feature Proposals**: Suggest new features or improvements to existing ones.
1411
- **Documentation**: Improve or expand documentation to make it easier for users and developers.
1512
- **Fixing Issues**: Address open issues and contribute fixes.
16-
17-
18-
1913

2014
## Contribution Guidelines
2115

@@ -24,28 +18,16 @@ You can help improve the project in the following ways:
2418
- Ensure your changes don’t break existing functionality (run tests if available).
2519
- Make small, focused commits with clear messages.
2620

27-
28-
29-
3021
## A Quick Start Guide:
3122

32-
3323
### 1. Fork the Repository
3424

35-
36-
3725
Click the **Fork** button at the top-right corner of this repository to create your own copy.
3826

39-
40-
4127
### 2. Clone Your Fork
4228

43-
44-
4529
Clone the repository to your local machine:
4630

47-
48-
4931
```
5032
git clone https://github.com/your-username/python-fm-dapi-weaver.git
5133
cd python-fm-dapi-weaver
@@ -54,83 +36,59 @@ cd python-fm-dapi-weaver
5436

5537
### 3. Install Dependencies
5638

57-
58-
5939
It's recommended to use a virtual environment:
6040

61-
62-
6341
```
6442
python -m venv venv
6543
source venv/bin/activate  # On Windows use `venv\Scripts\activate`
6644
pip install -r requirements.txt
67-
45+
6846
6947
```
7048

7149
### 4. Run the Server
7250

73-
7451
you can run the server using below command:
7552

76-
77-
7853
```
7954
python -m python_fm_dapi_weaver.main
80-
55+
8156
```
8257

8358
### 5. Test the API
8459

85-
86-
8760
Once the server is running, you can test the API using tools like [Postman](https://www.postman.com/). The server should be accessible at `http://127.0.0.1:8000`.
8861

89-
9062
### 6. Make Changes
9163

9264
Feel free to make changes or add new features! You can modify the code in the `python_fm_dapi_weaver` directory and test locally to ensure your changes work as expected.
9365

94-
9566
For example, to add a new feature, you might:
67+
9668
- Create a new module or file in the `python_fm_dapi_weaver` folder.
9769
- Modify existing files if you're improving or fixing existing functionality.
9870
- Ensure your changes align with the overall structure and coding style of the project.
9971

100-
72+
### 7. **Commit the Changes:**
10173

102-
### 7. **Commit the Changes:**
10374
Commit your work with a concise, clear message about what was modified.
10475

76+
### 8. **Push to Your Fork on GitHub:**
10577

106-
107-
### 8. **Push to Your Fork on GitHub:**
10878
Push the branch/changes to your GitHub Repository.
10979

110-
111-
112-
### 9. **Submitting changes:**
80+
### 9. **Submitting changes:**
11381

11482
Please open a Pull Request with a list of what you've done.Make sure, if possible, keep all of your commits are atomic (one feature per commit).
11583

116-
11784
## Code of Conduct and Licensing
11885

119-
By participating in this project, you agree to abide by our [Code of Conduct](CODE_OF_CONDUCT.md) and are licensed under the project's [License](./LICENSE).
120-
121-
86+
By participating in this project, you agree to abide by our [Code of Conduct](CODE_OF_CONDUCT.md) and are licensed under the project's [License](./LICENSE).
12287

12388
# Thank You for Contributing!
12489

125-
126-
12790
Your contributions are what make this project great! We appreciate the time, effort, and ideas you put into helping us improve.
12891

129-
130-
13192
If you have any questions, feel free to reach out. We encourage everyone to contribute, no matter how big or small. Together, we can make this project even better!
13293

133-
134-
13594
Happy coding!!
136-

0 commit comments

Comments
 (0)