deadvey/mathgenerator
1
0
Fork 0
mirror of https://github.com/DeaDvey/mathgenerator.git synced 2025-11-28 06:25:23 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update CONTRIBUTING.md

Browse Source
This commit is contained in:
Luke Weiler
2022-12-18 23:52:59 -05:00
committed by GitHub
parent 87620c5573
commit 7bb7494ccc
1 changed files with 4 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
CONTRIBUTING.md
View File

@@ -3,12 +3,10 @@
This project wouldn't be possible without the generosity of contributors like you. Thank you! This project wouldn't be possible without the generosity of contributors like you. Thank you!
## How You Can Help ## How You Can Help
Currently, there are 5 main types of contributions * Add a generator idea to github issues.
* Fix bugs in existing generators. Check out the issues tab of the Github to see what bugs exist and need to be fixed.
1. Add a generator idea to github issues. * Write a generator. Follow the pattern in [the template](https://github.com/lukew3/mathgenerator/blob/main/mathgenerator/funcs/template.py) and the [template with comments](https://github.com/lukew3/mathgenerator/blob/main/mathgenerator/funcs/template_comments.py). Make sure to place your generator function into the correct subject folder of `mathgenerator/funcs/`. After you are finished, run `adoptGenerator.py` inside the `scripts` directory to update the README and `__init__.py` file.
2. Fix bugs in existing generators. Check out the issues tab of the Github to see what bugs exist and need to be fixed. * Improve demo/documentation site. The source code for the mathgenerator website is in the `gh-pages` branch. Let me know what changes you propose in the issues tab.
3. Write a generator. Follow the pattern in [the template](https://github.com/lukew3/mathgenerator/blob/main/mathgenerator/funcs/template.py) and the [template with comments](https://github.com/lukew3/mathgenerator/blob/main/mathgenerator/funcs/template_comments.py). Make sure to place your generator function into the correct subject folder of `mathgenerator/funcs/`. After you are finished, run `adoptGenerator.py` inside the `scripts` directory to update the README and `__init__.py` file.
4. Improve demo/documentation site. The source code for the mathgenerator website is in the `gh-pages` branch. Let me know what changes you propose in the issues tab.
If you find something else that you'd like to work on, leave an issue or make a pr, and I'll be sure to review it! If you find something else that you'd like to work on, leave an issue or make a pr, and I'll be sure to review it!