Skip to content

Commit 36fde6b

Browse files
committed
First draft of contribution document
1 parent 22011b7 commit 36fde6b

File tree

1 file changed

+67
-0
lines changed

1 file changed

+67
-0
lines changed

CONTRIBUTING.md

+67
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
Contributing
2+
============
3+
4+
Contributions are welcome and very much appreciated. Credit will be appropriately given.
5+
6+
## License
7+
8+
By contributing, you agree that your contributions will be licensed under its MIT License.
9+
10+
## Code contributions
11+
12+
To begin contributing to the project, please follow these steps.
13+
14+
1. [Fork](https://help.github.com/en/articles/fork-a-repo) the repo.
15+
2. Clone your fork locally:
16+
17+
```shell
18+
$ git clone [email protected]:your_username/backtester_options.git
19+
```
20+
21+
3. Create the environment and install dependencies:
22+
23+
```shell
24+
$ make init
25+
```
26+
27+
4. Create your development branch from `master`
28+
29+
```shell
30+
$ git checkout -b your_branch master
31+
```
32+
33+
5. Start coding your contribution (Thanks!)
34+
35+
6. Make sure your code passes all tests, lints and is formatted correctly (`TODO`: Add linting, code formatting to Travis.)
36+
37+
6. Submit a pull request with a brief explanation of your work.
38+
39+
## Types of Contributions
40+
41+
### Bug reports
42+
43+
Make sure to follow the setup steps detailed in the [readme](README.md). If you find a bug, please create an issue with the label `bug` and provide the following information:
44+
45+
- Operating System and version.
46+
- Steps taken to replicate the bug.
47+
- What was the expected output and what actually happend.
48+
- Any details of your local environment that might be helpful for troubleshooting.
49+
50+
### Bug fixes
51+
52+
If you find a bug issue you want to fix, follow the steps outlined [above](#code-contributions) and submit a pull request with a link to the original issue.
53+
54+
### Proposing Features
55+
56+
Create an issue detailing what functionality you'd like to see implemented. If you can, provide general advice as to how the proposed feature could be done.
57+
58+
### Implementing Features
59+
60+
Find an issue with the label `help wanted` or `improvement` and [start coding](#code-contributions).
61+
When you are done, submit a pull request with a link to the original issue and some code samples showing how the code works. Tests are expected when adding new functionality.
62+
63+
64+
### Documentation
65+
66+
We encourage users to improve our project documentation, either via docstrings, markdown documents to be added to the [project wiki](https://github.com/lambdaclass/backtester_options/wiki) or writing blog posts.
67+
Let us know via issues labeled `docs` and we'll credit you appropriately.

0 commit comments

Comments
 (0)