Skip to content

Commit c7f218c

Browse files
committed
Add link to survey in README.md
1 parent 409c61b commit c7f218c

File tree

2 files changed

+15
-6
lines changed

2 files changed

+15
-6
lines changed

README.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -198,7 +198,7 @@ Where `x` and `y` are are any value ranges.
198198
<!-- START mdsplit-ignore -->
199199
<h3>
200200
201-
[READ THE DOCUMENTATION TO SEE THESE EXAMPLES](https://alandefreitas.github.io/matplotplusplus/)
201+
[READ THE DOCUMENTATION TO SEE THESE EXAMPLES WITH THE IMAGES](https://alandefreitas.github.io/matplotplusplus/)
202202
203203
</h3>
204204
<!-- END mdsplit-ignore -->
@@ -9205,10 +9205,19 @@ You can also create the binary packages to install Matplot++ on other systems:
92059205
cpack .
92069206
```
92079207

9208-
## Contributing
9208+
## Community
9209+
9210+
### Getting involved
9211+
9212+
* After getting started with this library, please complete this [survey](http://www.alandefreitas.com/survey/alandefreitas/matplotplusplus) to let us know how we can improve your experience.
9213+
* Discussions are concentrated on our GitHub [discussions](https://github.com/alandefreitas/matplotplusplus/discussions) page. Don't refrain from asking questions and proposing ideas. If this library helps you create something interesting, please divulge it with the community.
9214+
* If you are a programmer with good ideas, please [share](https://github.com/alandefreitas/matplotplusplus/discussions/new) these ideas with us.
9215+
* Academic collaboration is more than welcome. It'd be great to see this library help people write lots and lots of academic papers.
92099216

92109217
### Ideas and Roadmap
92119218

9219+
Feel free to contribute with new features to this library. For complex features and changes, consider [getting feedback](https://github.com/alandefreitas/matplotplusplus/discussions/new) from the community first. Contributing to an existing code base with its own conventions might seem intricate at first but please don't let that discourage you from sharing your ideas.
9220+
92129221
There are many ways in which you can contribute to this library:
92139222

92149223
* Testing the library in new environments <sup>see [1](https://github.com/alandefreitas/matplotplusplus/issues?q=is%3Aopen+is%3Aissue+label%3A%22cross-platform+issue+-+windows%22), [2](https://github.com/alandefreitas/matplotplusplus/issues?q=is%3Aopen+is%3Aissue+label%3A%22cross-platform+issue+-+linux%22), [3](https://github.com/alandefreitas/matplotplusplus/issues?q=is%3Aopen+is%3Aissue+label%3A%22cross-platform+issue+-+macos%22) </sup>
@@ -9219,7 +9228,7 @@ There are many ways in which you can contribute to this library:
92199228
* Finding bugs in general <sup>see [1](https://github.com/alandefreitas/matplotplusplus/issues?q=is%3Aopen+is%3Aissue+label%3A%22bug+-+compilation+error%22), [2](https://github.com/alandefreitas/matplotplusplus/issues?q=is%3Aopen+is%3Aissue+label%3A%22bug+-+compilation+warning%22), [3](https://github.com/alandefreitas/matplotplusplus/issues?q=is%3Aopen+is%3Aissue+label%3A%22bug+-+runtime+error%22), [4](https://github.com/alandefreitas/matplotplusplus/issues?q=is%3Aopen+is%3Aissue+label%3A%22bug+-+runtime+warning%22) </sup>
92209229
* Whatever idea seems interesting to you
92219230

9222-
Contributions in which we are not interested:
9231+
The only thing we ask you is to make sure your contribution is not destructive. Some contributions in which we are not interested are:
92239232

92249233
* "I don't like this optional feature so I removed/deprecated it"
92259234
* "I removed this feature to support older versions of C++" but have not provided an equivalent alternative
@@ -9228,7 +9237,7 @@ Contributions in which we are not interested:
92289237

92299238
In doubt, please open a [discussion](https://github.com/alandefreitas/matplotplusplus/discussions) first
92309239

9231-
### Guidelines
9240+
### Contributing Guidelines
92329241

92339242
If contributing with code, please leave the OpenGL backend and pedantic mode ON (`-DBUILD_EXPERIMENTAL_OPENGL_BACKEND=ON -DBUILD_WITH_PEDANTIC_WARNINGS=ON`), use [cppcheck](http://cppcheck.sourceforge.net/), and [clang-format](https://clang.llvm.org/docs/ClangFormat.html).
92349243

mkdocs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,6 @@ markdown_extensions:
4545
- meta
4646

4747
extra_javascript:
48-
- javascripts/config.js
4948
- https://polyfill.io/v3/polyfill.min.js?features=es6
50-
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
49+
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
50+
# - javascripts/config.js # for extra javascript

0 commit comments

Comments
 (0)