Skip to content

Commit c3f53b2

Browse files
committed
docs: updated contribute guide
1 parent 4588222 commit c3f53b2

File tree

1 file changed

+26
-1
lines changed

1 file changed

+26
-1
lines changed

CONTRIBUTE.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,31 @@
11
# Contributing to the APEx Dispatch API
22

3-
## Registration of a new platform implementation
3+
## Making Contributions
4+
5+
Contributions to the APEx Dispatch API are welcome! If you have suggestions for improvements, bug fixes, or new features, please follow these steps:
6+
7+
1. **Fork the repository**: Create a personal copy of the repository on GitHub.
8+
2. **Create a new branch**: Use a descriptive name for your branch that reflects the changes you plan to make.
9+
```bash
10+
git checkout -b feature/your-feature-name
11+
```
12+
3. **Make your changes**: Implement the changes you want to contribute.
13+
4. **Write tests**: Ensure that your changes are covered by tests. Add new tests if necessary.
14+
5. **Run tests**: Verify that all tests pass before submitting your changes.
15+
```bash
16+
pytest
17+
```
18+
6. **Commit your changes**: Write a clear commit message that describes your changes.
19+
```bash
20+
git commit -m "Add feature: your feature description"
21+
```
22+
7. **Push your changes**: Push your branch to your forked repository.
23+
```bash
24+
git push origin feature/your-feature-name
25+
```
26+
8. **Create a pull request**: Go to the original repository and create a pull request (PR) from your branch. Provide a clear description of the changes and why they are needed.
27+
28+
## Registration of a new Platform Implementation
429

530
To add a new platform implementation, you will need to create a new class that inherits from the `BasePlatform` class located at [`app/platforms/base.py`](app/platforms/base.py). In this new class, you will need to implement all the abstract methods defined in the [`BasePlatform`](app/platforms/base.py) class. This will ensure that your new platform implementation adheres to the expected interface and functionality.
631

0 commit comments

Comments
 (0)