From eafb1f4fb41d1091b9dac75fbc61e387cdd7770d Mon Sep 17 00:00:00 2001 From: Tulsi Dey <70888802+deytulsi18@users.noreply.github.com> Date: Mon, 14 Dec 2020 20:33:10 +0530 Subject: [PATCH] Added Issue Template, Pull Request template, Code Of Conduct and READMe enhancements (#24) * Create CODE_OF_CONDUCT.md * Create pull_request_template.md * Update issue templates * Update README.md * Update CODE_OF_CONDUCT.md --- .github/ISSUE_TEMPLATE/bug_report.md | 36 +++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 29 +++++++++ .github/pull_request_template.md | 20 ++++++ CODE_OF_CONDUCT.md | 76 +++++++++++++++++++++++ README.md | 7 ++- 5 files changed, 166 insertions(+), 2 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/pull_request_template.md create mode 100644 CODE_OF_CONDUCT.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..0a17bf7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,36 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: bug +assignees: '' + +--- + +--- +name: Bug report +about: Create a report to help us improve. +title: Bug report +labels: bug +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. +2. +3. +4. + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Actual behavior** +A clear and concise description of how the code performed w.r.t expectations. + +**Screenshots** +If applicable, add screenshots to help explain your problem. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..d3eae7a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,29 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: enhancement +assignees: '' + +--- + +--- +name: Feature request +about: Suggest an idea for this project +title: Feature request +labels: feature +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..eb66863 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,20 @@ +# Related Issue +- issue goes here + +# Prosposed Changes +- change 1 +- change 2 + +# Additional Info +- any additional information or context + +# Checklist +- [ ] Tests +- [ ] Translations +- [ ] Documentations + +# Screenshots + +Original | Updated +:-------------------------:|:-------------------------: +** original screenshot ** | ** updated screenshot ** diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..73e7f5c --- /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 in [Project Server](https://discord.com/invite/DswQDgyF8a). 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/README.md b/README.md index 25079ce..6e9b769 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,8 @@ -# Vendor Relief -## Android App for people of India during this Pandemic of Covid-19 +

+ website title image +

🏥 Android App for people of India during this Pandemic of Covid-19 🏥

+

+ 1. During COVID-19, people living in societies and apartments may not be aware of the nearby shops and vendors whether they are providing essential services or not (such as Groceries, Pharmacy, Dairy, etc) and if they may be providing the people may not know the details of the vendors(like timings, contact number and address of the shop). 2. People may be facing some doubts about covid-19. 3. After knowing about these problems faced by some of the people ,we have done our best to help them out.