Restyle Dwoc contributions

CODE_OF_CONDUCT.md

@@ -0,0 +1,77 @@
+<h1 align = "center"> Contributor Covenant Code of Conduct </h1>
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex, level of experience, education, socio-economic
+status, nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, or to ban temporarily or permanently any
+contributor for other behaviors that they deem inappropriate, threatening,
+offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team. All complaints will be reviewed and
+investigated and will result in a response that is deemed necessary and
+appropriate to the circumstances. The project team is obligated to maintain
+confidentiality with regard to the reporter of an incident. Further details of
+specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.4, available at
+https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

CONTRIBUTING.md

@@ -2,50 +2,45 @@
 
 Looking to contribute to this project ? All valid PRs are welcome.
 
+#### CONTRIBUTING GUIDELINES FOR DEVSCRIPT WINTER OF CODE PARTICIPANTS
+
 Follow these steps to set your local repository up and start contributing :
 
 1. Fork this repository.
-2. Clone the forked repository : ```git clone https://github.com/<YOUR_USERNAME>/rake_new2.git```
-3. cd to the directory on your local machine : ```cd rake_new2```
-4. Add upstream : ```git remote add upstream https://github.com/BALaka-18/rake_new2.git```
-5. That's it ! You're all set to go !
+2. Clone the forked repository :
+   `git clone https://github.com/<YOUR_USERNAME>/rake_new2.git`
+3. cd to the directory on your local machine : `cd rake_new2`
+4. Add upstream :
+   `git remote add upstream https://github.com/BALaka-18/rake_new2.git`
+5. Checkout to the DWOC branch : `git checkout DWOC-contributions`
+6. That's it ! You're all set to go !
 
-#### NOTE : 
-Make sure before you start making changes locally, you pull the code from the upstream everytime to make sure your local repository (remote) is even with the original repository (upstream).
-Command to pull code : ```git pull origin <BRANCH_NAME>```  (For now, the branch name will be ```main```)
+#### NOTE :
 
-_____________________________________________________________________________________________________________________________________________________________________________________________
+Make sure before you start making changes locally, you pull the code from the
+upstream everytime to make sure your local repository (remote) is even with the
+original repository (upstream). Command to pull code :
+`git pull origin <BRANCH_NAME>` (For now, the branch name will be
+`DWOC-contributions`)
 
-### BUT I'VE MADE THE CHANGES. WHAT NEXT ?
-NOTE : It is preferred that you create a new branch for every change that you make. It is NOT advisable to make changes on the master branch itself.
+---
 
-Steps to create a new branch :
+### BUT I'VE MADE THE CHANGES. WHAT NEXT ?
 
-1. Checkout to a new branch : ```git checkout -b <APPRORIATE_NAME>```  
+NOTE : MAKE SURE YOU'VE FOLLOWED THE FILE NAMING OR FOLDER NAMING CONVENTIONS
 
------------------------------------------------------------------------------------------------------------------------------------------
+To make a PR, just follow these steps :
 
-NOTE : The branch name must follow these conventions                                                                                     
-
-1. Branch name must be in lowercase.                                                                                                    
-2. Branch name must contain only letters, digits and dashes/underscores.                                                                 
-3. Branch name must be short and give an idea as to what change you're going to make. E.g. : ```git checkout -b update-readme```
+    a. Stage your changes : git add .
 
------------------------------------------------------------------------------------------------------------------------------------------  
+    b. Commit your changes : git commit -m "<proper commit message>"
 
-2. Make the changes on that branch.
-3. To make a PR, just follow these steps :
+    c. Push them to your forked repository : git push origin DWOC-contributions
 
-    a. Stage your changes : ```git add .```
-
-    b. Commit your changes : ```git commit -m "<proper commit message>"```
-
-    c. Push them to your forked repository : ```git push origin <NEW_BRANCH_NAME>```
-
     d. Go to your forked repository and refresh, you'll receive a prompt to create a PR. Make sure you write a proper PR description, else, your PR will be rejected.
-    
+
     e. Wait for the maintainer to review your PR.
-_____________________________________________________________________________________________________________________________________________________________________________________________
 
-#### HAPPY CONTRIBUTING !! 
+---
 
+#### HAPPY CONTRIBUTING !!

README.md

@@ -7,7 +7,7 @@
 [![GitHub forks](https://img.shields.io/github/forks/BALaka-18/rake_new2?style=social)](https://github.com/BALaka-18/rake_new2/network/members)
 [![GitHub stars](https://img.shields.io/github/stars/BALaka-18/rake_new2?style=social)](https://github.com/BALaka-18/rake_new2/stargazers)
 
-________________________________________________________________________________________________________________________________________________________________________________
+---
 
 <p align="center">
        <img src="https://miro.medium.com/max/1282/1*M6NUbP09lwQpaTcywBzU7w.png" alt="WoC logo" width="720" height="300" />
@@ -17,18 +17,17 @@ ________________________________________________________________________________
    <strong>WINTER OF CODE 2020 PROJECT IDEAS FOR rake_new2 : <a href = "https://github.com/dsc-iem/WoC-Project-Ideas#rake_new2">Read all project ideas here</a></strong>
 </p>
 
-
 <p align="center">
-   <strong> ---- ALL STUDENTS FOR THIS SEASON OF WoC HAVE BEEN SELECTED ALREADY. NO LONGER ACCEPTING PROPOSALS. ---- </strong> Head over to DevScript Winter of Code logo if you want to contribute. 
+   <strong> ---- ALL STUDENTS FOR THIS SEASON OF WoC HAVE BEEN SELECTED ALREADY. NO LONGER ACCEPTING PROPOSALS. ---- </strong> Head over to DevScript Winter of Code logo if you want to contribute.
 </p>
 
-________________________________________________________________________________________________________________________________________________________________________________
+---
 
 <p align="center">
    <strong> --- AND --- </strong>
 </p>
 
-________________________________________________________________________________________________________________________________________________________________________________
+---
 
 <p align="center">
        <img src="https://devscript.tech/woc/img/WOC-logo.png" alt="DWoC logo" width="300" height="300" />
@@ -38,7 +37,7 @@ ________________________________________________________________________________
    <strong>WINTER OF CODE 2020 PROJECT IDEAS FOR rake_new2 : <a href = "https://github.com/BALaka-18/rake_new2/issues?q=is%3Aissue+is%3Aopen+label%3ADWOC">See all updated and open Issues here. </a></strong> Comment to get assigned. Assignment is based on FCFS(First Come, First Serve) basis or based on better proposal/idea/worklflow.
 </p>
 
-________________________________________________________________________________________________________________________________________________________________________________
+---
 
 <h2 align="center">
    <strong>ABOUT THIS PROJECT</strong>
@@ -49,15 +48,17 @@ ________________________________________________________________________________
 </h3>
 
 rake_new2 is a Python library that enables simple and fast keyword extraction
-from any text. This library helps beginners or those lost while finding keywords, understand 
-which keywords are more important.
+from any text. This library helps beginners or those lost while finding
+keywords, understand which keywords are more important.
 
-HOW IS THIS DIFFERENT FROM ANY OTHER ALGORITHM ? : This library gives you weights/scores along with each keyword/keyphrase.
-This helps you pick out the correct key-phrases. Just choose the ones with more weights.  
+HOW IS THIS DIFFERENT FROM ANY OTHER ALGORITHM ? : This library gives you
+weights/scores along with each keyword/keyphrase. This helps you pick out the
+correct key-phrases. Just choose the ones with more weights.
 
 ┐(︶▽︶)┌
 
---> Psst! I tested it myself by writing my project abtract keywords using my library. The teacher has approved, so yeah, this works. (ʘ ͜ʖ ʘ) 
+--> Psst! I tested it myself by writing my project abtract keywords using my
+library. The teacher has approved, so yeah, this works. (ʘ ͜ʖ ʘ)
 
 ![Demo](https://user-images.githubusercontent.com/49288068/88929310-97fc2400-d297-11ea-811a-79d986cdfee4.png)