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

add testing instructions

Browse Source
This commit is contained in:
Luke Weiler
2024-01-08 21:38:32 -05:00
parent 6e11124a1c
commit 93f755c790
1 changed files with 2 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
CONTRIBUTING.md
View File

@@ -15,5 +15,6 @@ If you have never contributed to open source before here is a quick explanation
* Fork this repository on Github. This creates a copy of the current code that you can edit and make changes to. * Fork this repository on Github. This creates a copy of the current code that you can edit and make changes to.
* Navigate to your fork and make your changes. This could be done by cloning and making changes locally on your computer. You can find many tutorials on this online. You could also edit directly on Github if you don't have access to a text editor but doing this, you will not be able to test your function. * Navigate to your fork and make your changes. This could be done by cloning and making changes locally on your computer. You can find many tutorials on this online. You could also edit directly on Github if you don't have access to a text editor but doing this, you will not be able to test your function.
* Create a pull request. Navigate to [the math generator repository pull request tab](https://github.com/Todarith/mathGenerator/pulls) and click New Pull Request. Then click compare accross forks. Select your fork and branch as the head branch and leave a description. Then click Create Pull Request. * To test your changes, open a terminal and from the project root, run `pip install -e .` to install a locally editable version of the mathgenerator package. Then, run a python terminal with `python`, `import mathgenerato` and call the method you worked on.
* Commit and create a pull request. Navigate to [the math generator repository pull request tab](https://github.com/Todarith/mathGenerator/pulls) and click New Pull Request. Then click compare accross forks. Select your fork and branch as the head branch and leave a description. Then click Create Pull Request.
* If all goes well, your request will be approved and your generator added. Congratulations! * If all goes well, your request will be approved and your generator added. Congratulations!