Contributing

Contributions are welcome!

Bug Reports

For bug reports or requests please submit an issue or send a pull request.

Notebook Installation

Refer to Accessing the Challenges, Notebook Installation, and Nose Installation to set up your local environment.

Pull Requests

Please follow the general Repo Structure and Notebook Structure before submitting your pull request.

Adding Solutions to Existing Notebooks

If adding new solutions to existing notebooks:

Append your algorithm and code solution rather than replace a fellow contributor's work
Verify your code passes the unit tests

Adding New Challenges

There are several sample coding challenges that are not yet implemented such as the examples below.

These challenges are merely suggestions; feel free to send pull requests on different challenges, or even entire categories of challenges
Try to keep the "Challenge" title relatively short and expand on the details within the notebook
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!

Contributions in Languages Other than Python

Feel free to share your thoughts on how we could best approach adding challenges in other supported languages:

Repo structure
README static notebook links
Installation instructions
Etc

Style

Please refer to the style of existing notebooks to help maintain consistency. A consistently themed collection of notebooks might help users more seamlessly transition from challenge to challenge.

Review PEP-8 and the following style guide.

Notebook Author(s)

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.

3.2 KiB Raw Blame History