From 71c74f974d398070fe3208282b392b52c3e9f447 Mon Sep 17 00:00:00 2001 From: Yash Ajgaonkar <31548778+yash2189@users.noreply.github.com> Date: Fri, 16 Oct 2020 12:01:49 +0530 Subject: [PATCH] doc:Updated README.md --- CODE OF CONDUCT.md | 76 +++++++++++++++++++++++++++++++++++++++++++ CONTRIBUTING GUIDE.md | 18 ++++++++++ README.md | 37 ++++++++++++++++----- 3 files changed, 123 insertions(+), 8 deletions(-) create mode 100644 CODE OF CONDUCT.md create mode 100644 CONTRIBUTING GUIDE.md diff --git a/CODE OF CONDUCT.md b/CODE OF CONDUCT.md new file mode 100644 index 0000000..539a954 --- /dev/null +++ b/CODE OF CONDUCT.md @@ -0,0 +1,76 @@ +# Contributor Covenant Code of Conduct + +## 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 characteristics, gender identity and expression, +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 maintainer. 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 diff --git a/CONTRIBUTING GUIDE.md b/CONTRIBUTING GUIDE.md new file mode 100644 index 0000000..8212c98 --- /dev/null +++ b/CONTRIBUTING GUIDE.md @@ -0,0 +1,18 @@ +# Contributing + +When contributing to this repository, please first discuss the change you wish to make via issue, +email, or any other method with the owners of this repository before making a change. + +Please note we have a code of conduct, please follow it in all your interactions with the project. + +## Pull Request Process + +1. Fork the Project +2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) +3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) +4. Push to the Branch (`git push origin feature/AmazingFeature`) +5. Open a Pull Request + +## Code of Conduct + +Check the code of conduct [here](https://github.com/yash2189/tictactoe/blob/fix-readme/CODE%20OF%20CONDUCT.md). diff --git a/README.md b/README.md index 333530a..cf9fda7 100644 --- a/README.md +++ b/README.md @@ -2,13 +2,28 @@ Tic Tac Toe game (web version) made using HTML, JS. +Table of contents +================= + + + * [About the project](#about-the-project) + * [Tech Stack](#tech-stack) + * [Getting Started](#getting-started) + * [Prerequisites](#prerequisites) + * [Setting up the project](#setting-up-the-project) + * [Issues](#issues) + * [Contributing](#contributing) + * [Code of Conduct](#code-of-conduct) + * [License](#license) + + ## About The Project This is a very simple and light tic tac toe web game made using HTML, CSS and JS. This game is very easy to play. ![](tictactoe.png) -### Built With +### Tech Stack * HTML * JavaScript @@ -21,7 +36,7 @@ To get a local copy up and running follow these simple steps. ### Prerequisites There are no special requirements to play this game apart from having a Web Browser which supports HTML5 and CSS3. -### Installation +### Setting up the Project 1. Clone the repo ```sh @@ -29,12 +44,18 @@ git clone https://github.com/yelynn1/tictactoe.git ``` 2. Open the index.html file in any web browser. +## Issues + +Please file specific issues, bugs, or feature requests in our [issue tracker](https://github.com/yelynn1/tictactoe/issues). Follow the issue template while creating a new issue. + ## Contributing -Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**. +Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**. +If you wish to contribute a change to any of the existing features in this repo, please review our [contribution guide](https://github.com/yash2189/tictactoe/blob/fix-readme/CONTRIBUTING%20GUIDE.md) and send a [pull request](https://github.com/yelynn1/tictactoe/pulls). + +## Code of Conduct + +We follow certain guidelines in order to maintain this repository.Please find our [code of conduct](https://github.com/yash2189/tictactoe/blob/fix-readme/CODE%20OF%20CONDUCT.md) and read it carefully. -1. Fork the Project -2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) -3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) -4. Push to the Branch (`git push origin feature/AmazingFeature`) -5. Open a Pull Request +## License +Distributed under the MIT License.See `LICENSE` for more information.