Skip to content

Commit 1a1e1de

Browse files
committed
update contribute guide
1 parent 08a3b3d commit 1a1e1de

File tree

2 files changed

+28
-1
lines changed

2 files changed

+28
-1
lines changed

CONTRIBUTING.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# How to Contribute:
2+
3+
1. Fork the project
4+
5+
2. Clone it to your local system
6+
7+
3. Checkout a separate branch to make your changes
8+
9+
4. Make your changes
10+
11+
5. Push the changes back to your repo
12+
13+
6. Click the Compare & pull request button
14+
15+
7. Click Create pull request to open a new pull request to the **_development_** branch
16+
17+
___
18+
19+
Your pull request with be viewed, and merged into the development branch if it passes all of the tests.
20+
21+
If you have any questions, please don't hesitate to reach out to the developers.
22+

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323
<li><a href="#usage">Usage</a></li>
2424
<li><a href="#uninstallation">Uninstallation</a></li>
2525
<li><a href="#roadmap">Roadmap</a></li>
26+
<li><a href="#contribution">Contribution</a></li>
2627
</ol>
2728
</details>
2829

@@ -141,7 +142,7 @@ Uninstall the package like any other Python package using the pip uninstall comm
141142
pip uninstall alpha-homora-v2
142143
```
143144
144-
## Feature Roadmap:
145+
## Features:
145146
146147
- [ ] Avalanche:
147148
- [x] Get all open positions by owner wallet address
@@ -162,3 +163,7 @@ pip uninstall alpha-homora-v2
162163
- [ ] Get current pool APY
163164
- [ ] Add Liquidity
164165
- [ ] Remove Liquidity
166+
167+
## Contribution:
168+
169+
Contributions are welcome! Please read the [contribution guidelines](CONTRIBUTING.rst) to learn more about how to contribute to this project.

0 commit comments

Comments
 (0)