Skip to content
This repository was archived by the owner on Feb 29, 2024. It is now read-only.

Commit 7a7ff6e

Browse files
committed
Add CONTRIBUTING.md file
Fixes #3
1 parent 656d434 commit 7a7ff6e

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

CONTRIBUTING.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Contributing
2+
3+
This project is mainly targeted for MarsBased developers 👽 but we love pull request from earthlings too 🌍.
4+
5+
Before contributing make sure that there is not any [issue](https://github.com/MarsBased/pathfinder/issues) already created that covers the same problem / feature that you want to add.
6+
7+
We recommend you to create an issue before starting the development to better organize contributions.
8+
9+
## How to
10+
11+
First fork the repository on your own account and clone it.
12+
13+
```git clone git@github.com:your-username/pathfinder.git```
14+
15+
Make your feature addition or bug fix in a featurebranch.
16+
17+
Push your feature branch to GitHub and send us a [Pull Request](https://github.com/marsbased/pathfinder/compare)
18+
19+
Please, include a description of your changes and reference the issue that you are fixing in your commit.

0 commit comments

Comments
 (0)