From 7774f47ceae99c322511fe0eaa16bdd0bd73abed Mon Sep 17 00:00:00 2001 From: Ron Huberfeld <32178925+ron-huberfeld@users.noreply.github.com> Date: Sun, 31 Jan 2021 01:18:14 +0200 Subject: [PATCH] docs: adding community standard documents --- CODE_OF_CONDUCT.md | 76 ++++++++++++++++++++++++++++++++++++++++++++++ CONTRIBUTING.md | 25 +++++++++++++++ README.md | 35 +++++++++++++++++++-- 3 files changed, 133 insertions(+), 3 deletions(-) create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 00000000..c2ee0799 --- /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 project team at lms@pythonic.guru. 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.md b/CONTRIBUTING.md new file mode 100644 index 00000000..4a89a8a5 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,25 @@ +# Contributing +👍🎉 First off, thanks for taking the time to contribute! 🎉👍 + +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](https://github.com/PythonFreeCourse/calendar/blob/master/CODE_OF_CONDUCT.md), please follow it in all your interactions with the project. + +## Pull Requests +Create feature branches. + +One pull request per feature - If you want to do more than one thing, send multiple pull requests. + +Send coherent history - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](https://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting. + +## Guide +1. Fork the project. +2. Create a new branch (`git checkout -b 'branch name'`). +3. Commit your changes (`git commit -m 'Add something new'`). +4. Push to the branch (`git push -u origin 'branch name'`). +5. Open a Pull Request. + +## Style Guide +Follow the [commit messages specification](https://www.conventionalcommits.org/en/v1.0.0/). + +Happy coding! diff --git a/README.md b/README.md index cf148182..f6a278eb 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,43 @@ # PyLander -## Open Source Calendar built with Python +

+ +

-### Run on Windows: +👋 Welcome to Open Source Calendar built with Python. 🐍 + +* [Project's objectives](#Project's-objectives) +* [Creating development environment](#creating-development-environment) +* [Contributing](#contributing) +### Project's objectives +1. Develop open source calendar tool using new technics while trying new things. +2. Using Python as main programming language and plain HTML/JS for GUI. +3. Create bonding in our community. + +## Creating development environment +### Prerequisites +1. Windows or Linux based system - either [WSL on windows](https://docs.microsoft.com/en-us/windows/wsl/install-win10) or full blown linux. +2. [Python](https://www.python.org/downloads/release/python-385/) + +### Running on Windows ```shell virtualenv env .\env\Scripts\activate.bat pip install -r requirements.txt -# Copy configuration.py.example to configuration.py. +# Copy app\config.py.example to app\config.py. +# Edit the variables' values. +uvicorn app.main:app --reload +``` + +### Running on Linux +```shell +python -m venv venv +source venv/bin/activate +pip install -r requirements.txt +cp app/config.py.example app/configuration.py # Edit the variables' values. uvicorn app.main:app --reload ``` +## Contributing +View [contributing guidelines](https://github.com/PythonFreeCourse/calendar/blob/master/CONTRIBUTING.md).