-
Notifications
You must be signed in to change notification settings - Fork 2
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
2 changed files
with
84 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,40 @@ | ||
| # Contributing to Labs | ||
|
|
||
| 👍🎉 First off, thanks for taking the time to contribute! 🎉👍 | ||
|
|
||
| ## Before you start | ||
|
|
||
| * Comment on the issue that you plan to work on so we can assign it to you and there isn't unnecessary duplication of work. | ||
| * If you're fixing some smaller issue - please check the list of pending Pull Requests to avoid unnecessary duplication. | ||
|
|
||
| ## How can you help | ||
|
|
||
| You can help in multiple ways: | ||
| * Reproducing bugs, finding its root cause and providing fixes to that, this will be appreciated a lot (see the issues with label: `bug`) | ||
| * Sending Pull Requests for new experiment (see the issues with label: `new experiment`) | ||
| * Doing Code Reviews on the Pull Requests from the developers of this community and verifying if PRs are working correctly or not | ||
|
|
||
| ## Pull Requests | ||
|
|
||
| All contributions are done through Pull Requests here on GitHub. | ||
|
|
||
| Please follow the guidelines below:- | ||
|
|
||
| * Submit all code changes via pull requests (PRs) rather than through a direct commit. PRs will be reviewed and potentially merged by the repo maintainers after a peer review that includes at least one maintainer. | ||
| * **DO NOT** submit "work in progress" PRs. A PR should only be submitted when it is considered ready for review and subsequent merging by the contributor. | ||
|
|
||
| ## Linting | ||
|
|
||
| We use [nblint](https://pypi.org/project/nblint/) for ensuring Labs is nice and easy to use and work on long-term. | ||
|
|
||
|
|
||
| ## Coding Style Changes | ||
|
|
||
| Please: | ||
| * **DO NOT** send PRs for style changes. For example, do not send PRs that are focused on changing usage of ```Int32``` to ```int```. | ||
| * **DO NOT** send PRs for upgrading code to use newer language features, though it's ok to use newer language features as part of new code that's written. For example, it's ok to use expression-bodied members as part of new code you write, but do not send a PR focused on changing existing properties or methods to use the feature. | ||
| Give priority to the current style of the project or file you're changing even if it diverges from the general guidelines. | ||
|
|
||
| ## Code Reviews | ||
|
|
||
| All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose. Consult [GitHub Help](https://help.github). |
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,44 @@ | ||
| # Labs | ||
| Community Driven Data Science & Machine Learning Experiments at SIESGSTarena | ||
|
|
||
|  | ||
|  | ||
|
|
||
| - [About](#about) | ||
| - [Set of Experiments](#set-of-experiemnts) | ||
| - [Communication](#communication) | ||
| - [Contributing](#contributing) | ||
| - [Contact](#contact) | ||
| - [License](#license) | ||
|
|
||
| ## About | ||
| Labs is a one stop for all Data Science and Machine Learning enthusiasts to learn and contribute to one of the several research activities carried out by SIESGSTarena team. Its a community driven project where every novice and experienced can make use of our datasets and try to come up with several visualizations, pre-trained models and any other research work which can be deployed on SIESGSTarena or published in general. | ||
|
|
||
| ## Set of Experiments (just few examples, you can do more than what's said here) | ||
|
|
||
| * Recommendation of Blogs to users | ||
| * Recommendation of problems to users based on past submissions | ||
| * A statistical representation of progress of users in respective topics ('tags' feature in the dataset) of competitive programming in SIESGSTarena | ||
|
|
||
| **Refer [code-drills](https://www.code-drills.com/) for further clarity.** | ||
|
|
||
|
|
||
| ## Communication | ||
|
|
||
| **GitHub Issues**: bug reports, feature requests, install issues, help wanted, thoughts, etc. | ||
|
|
||
| ## Contributing | ||
|
|
||
| We appreciate all contributions and make sure you go through our [Contributing Guide](CONTRIBUTING.md). If you are planning to contribute back bug-fixes, please do so without any further discussion. | ||
|
|
||
| If you plan to contribute new experiments, utility functions or extensions to the core, please first open an issue and discuss the feature/experiment with us. | ||
| Sending a PR without discussion might end up resulting in a rejected PR, because we might be taking Labs in a different direction than you might be aware of. | ||
|
|
||
| ## Contact | ||
|
|
||
| * **Omkar Prabhu** - [prabhuomkar](https://github.com/prabhuomkar) - prabhuomkar@pm.me | ||
| * **Shambhavi Sudarsan** - [ShambhaviSudarsan](https://github.com/ShambhaviSudarsan) - shambhavi.sudarsan17@siesgst.ac.in | ||
|
|
||
| ## License | ||
|
|
||
| All the notebooks in this repository are published under the terms of the MIT License, as found in the [LICENSE](LICENSE) file. |