Skip to content

Commit

Permalink
Merge pull request #94 from TheAlgorithms/move_contributing_section
Browse files Browse the repository at this point in the history
Move contributing section to `Contributing.md`
  • Loading branch information
hritik5102 authored Apr 30, 2024
2 parents 470fdc3 + cd42cc0 commit b7b066c
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 11 deletions.
11 changes: 11 additions & 0 deletions Contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,17 @@ Now submit the pull request.

Soon I'll be merging all your changes into the master branch of this project. You will get a notification email once the changes have been merged.

## 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

If you're adding new **datasets** they need to be saved in the `/data` folder. CSV files are preferable. The size of the file should not be greater than `30Mb`.

## Where to go from here?

Congrats! You just completed the standard _fork -> clone -> edit -> PR_ workflow that you'll encounter often as a contributor!
Expand Down
11 changes: 0 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,6 @@ You can run and edit the algorithms or contribute to them using [Gitpod.io](http

[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](http://gitpod.io/#https://github.com/TheAlgorithms/Jupyter)

## 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

If you're adding new **datasets** they need to be saved in the `/data` folder. CSV files are preferable. The size of the file should not be greater than `30Mb`.

## Contributing

Before removing any bug, or adding new algorithm please do the following: **[Check Contribution Guidelines Before Contribution](Contributing.md)** and also please read **[CODE OF CONDUCT](CODE_OF_CONDUCT.md)**.
Expand Down

0 comments on commit b7b066c

Please sign in to comment.