Skip to content

Commit f417c45

Browse files
Create CONTRIBUTING.md
1 parent d5ed4c8 commit f417c45

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

CONTRIBUTING.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
- There are many ways to contribute, including contributions as simple as **asking questions**, participating in discussions, suggesting enhancements, etc. **All** of these are valuable!
2+
3+
- All of the usual/typical open source contribution guidelines apply (see for example, https://matplotlib.org/3.1.1/devel/contributing.html)
4+
so we will mention here just a few items here for which we may be particular in mplfinance.
5+
6+
- Coding:
7+
- If you write code, please don't use tabs, rather use spaces.
8+
- If you add a significant feature, that is a feature for which explaining its usage takes more than just a sentence or two, please also create a "tutorial notebook" for that feature. For example, see the jupyter notebooks in the examples folder: https://github.com/matplotlib/mplfinance/tree/master/examples
9+
- If you add a significant feature, please also create a regression test file in the tests folder, https://github.com/matplotlib/mplfinance/tree/master/tests, similar to the other regression tests that are there. *Often, the simplest way to do this is to take a few of the examples from the feature's "tutorial notebook"* (see previous point).

0 commit comments

Comments
 (0)