diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3572d14..60282a8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,20 +2,22 @@ ### Contributing Guidelines! - Read this space to know the contributing guidelines. Please follow the guidelines for smooth contribution. Following the guidelines reflect your courtesy towards the open source contribution. The issues, potential changes and pull requests will be addressed in compliance with the quality of need and urgency. +Read this section to familiarize yourself with this project's contributing guidelines. Please follow the guidelines for a smooth contribution. Following the guidelines reflects your courtesy towards this open source project and open source contribution in general. Issues, potential changes and pull requests will be addressed in accordance with their quality, necessity, and urgency. ### Expected Contribution: -In case you are willing to contribute in any form, You're most Welcome! Improvement in documentation, reporting bugs and mistakes is expected in general. + +You're most welcome to contribute to this project in any form! The general expected contributions are 1. Improvement in documentation 2. Bug or mistake reporting # Getting started ## Ground Rules -Issues should be created to submit a change to the repository before opening a pull request. Communication in any form except the repository channels is not expected and will not be entertained. +An issue should be created to submit a change to the repository before opening a pull request. Communication is to take place only through specified repository channels – communication outside of these channels will not be tolerated. # Your First Contribution -In case you have additions to the concepts, codebase, or anything relevant, You're most welcome to open an issue, followed by opening a pull request. You are again welcome to report a mistake in the existing content, and code obselete issues. +If you want to contribute additions to the concepts, codebase, or anything relevant to the project, you're most welcome to open an issue, followed by opening a pull request. You are also welcome to report a mistake in the existing content, and code obsolete issues. ### Know More about open Source Contributions: + Here are a couple of friendly tutorials you can go through: http://makeapullrequest.com/ and http://www.firsttimersonly.com/ diff --git a/README.md b/README.md index a499cca..a30eef0 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ # Learning-Object-Oriented-Python -![](https://www.codetriage.com/josharsh/learning-object-oriented-python/badges/users.svg) -This repository walks you through the Object Oriented Programming in python. Illustrates real world examples, working codes and going about finding a coding solution. +![](https://www.codetriage.com/josharsh/learning-object-oriented-python/badges/users.svg) +This repository walks you through Object Oriented Programming in Python. It illustrates real-world examples of working code and provides opportunities for you to write your own coding solutions.