Contributions are welcome!
Please carefully read this page before submitting a pull request.
For bug reports or requests submit an issue.
Please follow the general Repo Structure and Notebook Structure before submitting your pull request.
If you are not familiar with pull requests, review the pull request docs.
Refer to Accessing the Challenges, Notebook Installation, and Nose Installation to set up your local environment.
Challenges have multiple solutions. If adding new solutions to existing challenges:
- Add your algorithm discusion and code solution to the existing notebook
- Update the unit test to include your solution
- Verify your code passes the unit tests
The README contains several sample challenges that are not yet implemented.
- The sample challenges are only suggestions, please do not limit yourself to only these topics
- Feel free to send pull requests on different challenges or categories of challenges
- Try to keep the "Challenge" title relatively short and expand on the details within the notebook
- Review the Repo Structure and Notebook Structure sections
- Check out the template challenge and solution notebooks to help you get started
| Challenge | Static Notebooks |
|---|---|
| Check if a number is prime | Contribute│Contribute |
| Generate a list of primes | Contribute│Contribute |
Update the list of challenges in the README so we can enjoy your challenge!
When contributing to a notebook, update the notebook author(s):
This notebook was prepared by Joe and Jane. Source and license info is on GitHub.
Please refer to the style of existing notebooks to help maintain consistency. A consistently themed collection of notebooks will help users more seamlessly transition from challenge to challenge.
Review PEP-8 and the following style guide.
Feel free to share your thoughts on how we could best approach adding challenges in other supported languages:
- Repo structure
- README challenge list
- Installation instructions
- Etc
Share your thoughts in this issue.