added README template and made changes in CONTRIBUTING.md

siesgstarena · Apr 6, 2020 · 4817d21 · 4817d21
1 parent 1f0d9c6
commit 4817d21
Show file tree

Hide file tree

Showing 2 changed files with 60 additions and 15 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -11,7 +11,7 @@
 ## How to start
 
 * Create issue using the issue templates provided by selecting from option after clicking new issue. This will allow us to know on what experiment you want to work and we can provide guidence/suggestion about it.
-* After selecting issue template you will se some pre-written info in the description of issue fill that info. For every template the info needed may vary. If you have something more to add feel free to add in the issue.
+* After selecting issue template you will se some pre-written info in the description of issue fill that info. For every template the info needed may variey. If you have something more to add feel free to add in the issue.
 * You can start working on the issue after you are done creating one. Please follow the contribution guidelines while writing the code.
 * 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.
@@ -27,27 +27,24 @@ You can help in multiple ways:
 
 All contributions are done through Pull Requests here on GitHub.
 
-### Guidelines for PRs
+Please follow the guidelines below:-
 
-* Submit all code changes via pull requests (PRs) to master branch. PRs will be reviewed and potentially merged by the repo maintainers after a peer review that includes at least two maintainers.
-* **DO NOT** submit "work in progress" PRs. PR should only be submitted when it is considered ready for review and subsequent merging by the contributor.
+* 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.
+* Make sure to add README for your code. A <a href="https://github.com/siesgstarena/labs/blob/master/README-template.md">README-template</a> has been provided for that purpose.
+* **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 Notebooks and [pylint](https://pypi.org/project/pylint/) for Python source files for ensuring Labs is nice and easy to use and work on long-term.
+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
-
-#### DON'T
 
-* Send PRs for style changes. For example, do not send PRs that are focused on changing usage of ```Int32``` to ```int```.
-
-#### DO
+## Coding Style Changes
 
-* Send PRs for upgrading code to use newer language features as it's ok to use newer language features as part of new code that's written.
+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 from maintainers of this repository.
-* Don't worry, you will remain the owner and maintain essence of the code, we will provide suggestions on how to avoid redundancy and doing structuring of code which adher to certain guidelines of this repository.
-* We use GitHub pull requests (PRs) for this purpose. Consult [GitHub Help](https://help.github.com) for learning about PR.
+All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose. Consult [GitHub Help](https://help.github).
diff --git a/README_template.md b/README_template.md
@@ -0,0 +1,48 @@
+
+This is a README template for all the contributors of <a href="https://github.com/siesgstarena/labs">Labs</a>. Make sure to fill these details before a PR. 
+<br>
+
+## Title
+> Title of the project.
+<br>
+
+## About
+> A short description about what your code does.
+<br>
+
+## Setup 
+> Describe how to install all development dependencies.
+<br>
+
+
+### Installation (if any)
+OS X & Linux:
+
+```
+npm install requirements.txt
+```
+
+Windows:
+
+```
+edit autoexec.bat
+```
+<br>
+
+
+## Training/Testing/Running (if any) 
+<br>
+
+
+## Results/Visualizations
+> Include accuracy of predictions, output of visualizations (if any).
+
+<br>
+
+## Acknowledgements (if any)
+<br>
+
+
+## Licenses (if any)
+
+