Skip to content

Commit 1dfedcb

Browse files
update CONTRIBUTING and README
1 parent 5784d86 commit 1dfedcb

File tree

2 files changed

+9
-24
lines changed

2 files changed

+9
-24
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
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!
1+
- Contributing can as simple as **asking questions**, participating in discussions, suggesting enhancements, etc. **All of these are valuable!** There are many ways to contribute.
2+
3+
- All of the usual/typical open source contribution guidelines apply (see for example, **[Matplotlib Contributing](https://matplotlib.org/3.1.1/devel/contributing.html)** and **[Open Source Guide to Contributing](https://opensource.guide/how-to-contribute/)**)
4+
so here, on this page, we will mention just a few items for which we may be particular in **mplfinance**.
25

3-
- All of the usual/typical open source contribution guidelines apply (see for example, https://matplotlib.org/3.1.1/devel/contributing.html and https://opensource.guide/how-to-contribute/)
4-
so we will mention here just a few items here for which we may be particular in mplfinance.
56

67
- 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 examples of tutorial notebooks, please 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).
8+
- If you write code, please don't use tabs; rather use spaces.
9+
- If you add a significant feature, that is a feature for which explaining its usage takes more than just a few sentences, please also create a "tutorial notebook" for that feature. **[For examples of tutorial notebooks, please see the jupyter notebooks in the examples folder.](https://github.com/matplotlib/mplfinance/tree/master/examples)**
10+
- 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).

README.md

Lines changed: 2 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@
1919
- **[Saving the Plot to a File](https://github.com/matplotlib/mplfinance/blob/master/examples/savefig.ipynb)**
2020
- **[Customizing the Appearance of Plots](https://github.com/matplotlib/mplfinance/blob/master/examples/customization_and_styles.ipynb)**
2121
- **[Price-Movement Plots (Renko, P&F, etc)](https://github.com/matplotlib/mplfinance/blob/master/examples/price-movement_plots.ipynb)**
22-
- Technical Studies (presently in development)
23-
- **[Latest Release Info](https://github.com/matplotlib/mplfinance#release)**
22+
- **[Trends, Support, Resistance, and Trading Lines](https://github.com/matplotlib/mplfinance/blob/master/examples/using_lines.ipynb)**
23+
- **[Latest Release Info](https://github.com/matplotlib/mplfinance/blob/master/RELEASE_NOTES.md)**
2424
- **[Some Background History About This Package](https://github.com/matplotlib/mplfinance#history)**
2525
- **[Old API Availability](https://github.com/matplotlib/mplfinance#oldapi)**
2626

@@ -568,22 +568,6 @@ mpf.plot(df[700:850],type='bars',volume=True,mav=(20,40))
568568

569569
For more examples of using mplfinance, please see the jupyter notebooks in the **[`examples`](https://github.com/matplotlib/mplfinance/blob/master/examples/)** directory.
570570

571-
---
572-
573-
# <a name="release"></a>Release Notes
574-
575-
| Version | Description | Release Date |
576-
|:---------|:-------------|:---------------|
577-
| 0.12.3a3 | - `linecolor` kwarg for line plots<br> - implement save figure to in-memory buffer<br> -- Thank you Caleb Coffin @coffincw for contributing the above. | 2020-03-04 |
578-
| 0.12.3a2 | - implement custom markers (issue#30)<br> - fix minor issue with chart `type` validator<br> -- Thank you Amir Atashin @amiaty for contributing the above.<br> - add internal functions: `_bypass_kwarg_validation()` and `_kwarg_not_implemented()` | 2020-02-21 |
579-
| 0.12.3a1 | - fix issue#28: math.log crash on zero in data<br> - remove "Implemented" field from kwarg dicts<br> - yahoo style show colors for `ohlc bars` | 2020-02-16 |
580-
| 0.12.3a0 | - kwarg `block=False` for non-blocking call to `mpf.plot()`<br> - customize aspect ratio, figure title, y-labels<br> - customize colors and other `style` aspects of plot<br> - `no_xgaps` now defaults to True: use `show_nontrading=True` to set no_xgaps to false<br> - secondary y-axis available to `make_addplot()`<br> - bug fix for volume widths | 2020-02-12 |
581-
| 0.12.0a3 | Increase mav limit from 3 to 7 different mavs | 2020-01-16 |
582-
| 0.12.0a2 | Ability to save plot to a file (pdf, svg, png, jpg, ...) | 2020-01-14 |
583-
| 0.12.0a1 | Ability to plot arbitrary user data (in addition to basic OHLCV data).<br> - both line and scatter plots available.<br> - optionally plot on either the "main" or "lower" (aka "volume") axis. | 2020-01-09 |
584-
| 0.11.x | Basic Plotting from Pandas DataFrame of OHLC bars and candlesticks.<br> - optional display of volume<br> - optional display of (up to 3 different) moving averages.<br> - old API still available by importing from "mplfinance/original_flavor" | 2019-12-20 |
585-
| 0.10.x | Old mpl-finance API set up as its own package<br> (i.e. removed from the matplotlib package). | 2016-09-08 |
586-
587571
---
588572

589573
## <a name="history"></a>Some History

0 commit comments

Comments
 (0)