forked from trekhleb/homemade-machine-learning
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
19 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
## Contributing | ||
|
||
#### General Rules | ||
|
||
- As much as possible, try to follow the existing format of markdown and code. | ||
- Don't forget to run `pylint ./homemade` before submitting pull requests. | ||
|
||
#### Contributing New Translation | ||
|
||
- Create new `README.xx-XX.md` file with translation alongside with main `README.md` file where `xx-XX` is [locale and country/region codes](http://www.lingoes.net/en/translator/langcode.htm). For example `en-US`, `zh-CN`, `zh-TW`, `ko-KR` etc. | ||
- You may also translate all other sub-folders by creating related `README.xx-XX.md` files in each of them. | ||
|
||
#### Contributing New Algorithms | ||
|
||
- Make your pull requests to be **specific** and **focused**. Instead of contributing "several algorithms" all at once contribute them all one by one separately (i.e. one pull request for "Logistic Regression", another one for "K-Means" and so on). | ||
- Every new algorithm must have: | ||
- **Source code** with comments and readable namings | ||
- **Math** being explained in README.md along with the code | ||
- **Jupyter demo notebook** with example of how this new algorithm may be applied |