Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 22 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,21 @@
# Guidance on how to contribute

There are two primary ways to help:
- Using the issue tracker, and
- Improving the code-base.
- Propose an exercise using the issue tracker, and
- Propose a solution using the pull request


## Using the issue tracker
## Propose an exercise using the issue tracker

One generally uses the issue tracker to suggest feature requests, report bugs, and ask questions.
For our project, you are welcome to propose new exercises to be included in this project by creating an new issue.
Describe what you would like in this exercise and if possible propose what the solution should look like.

If you can write up the codes for the solution, then follow the _Improving the code-base_guidance below.
If you can write up the exercise statment or the codes for the solution, then follow the guide below.


## Propose a solution using the pull request

## Improving the code-base
### General github workflow

Generally speaking, you should fork this repository, make changes in your own fork, and then submit a pull request (PR).
This is the primary way for you to submit solutions to the exercise in codes.
Expand All @@ -32,3 +33,18 @@ If you are not familir with git, we follow the general ["fork-and-pull"](https:/
9. (Optionally) Delete your branch.


## Structuring the execise or solution

First, create the folder based on the next number of the project. For e.g., if you see `015` folder being the latest project folder, then create the `016` folder. Within that, the directory layout should be:

.
├── exercise # Exercise folder
│ └── readme.md # A mark-down clear and expansive description of the exercise. Data, goals, methods to use and etc
└── solution # Solution Folder
├── readme.md # A short description on the solutions and what each file does
└── random_forest.ipynb # Jupyter notebook solution
└── cnn.py # A python .py solution
└── ...