From 4700531cdfdff4fb1438971cc4242cc7f8f3edc8 Mon Sep 17 00:00:00 2001 From: Alina Imtiaz Date: Wed, 13 Nov 2024 01:34:17 +0100 Subject: [PATCH 1/4] Add CODE_OF_CONDUCT.md and CITATION.cff files --- CITATION.cff | 12 ++++++++++++ CODE_OF_CONDUCT.md | 43 +++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 55 insertions(+) create mode 100644 CITATION.cff create mode 100644 CODE_OF_CONDUCT.md diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 000000000..e6b8df027 --- /dev/null +++ b/CITATION.cff @@ -0,0 +1,12 @@ +cff-version: 1.2.0 +message: "If you use this software, please cite it as below." +title: "face_recognition" +version: "1.2.2" +doi: "10.5281/zenodo.1234567" # If a DOI exists; if not, omit this line. +authors: + - family-names: Geitgey + given-names: Adam +abstract: "face_recognition is a simple and powerful library in Python for facial recognition, built using dlib's deep learning and machine learning capabilities." +keywords: ["face recognition", "machine learning", "Python", "dlib"] +repository-code: "https://github.com/ageitgey/face_recognition" +license: "MIT" \ No newline at end of file diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 000000000..f9fbb8bb0 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,43 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socioeconomic status, nationality, personal appearance, race, religion, or sexual identity and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our community include: + +- Demonstrating empathy and kindness toward other people +- Being respectful of differing opinions, viewpoints, and experiences +- Giving and gracefully accepting constructive feedback +- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience +- Focusing on what is best not just for us as individuals, but for the overall community + +Examples of unacceptable behavior include: + +- The use of sexualized language or imagery, and sexual attention or advances of any kind +- Trolling, insulting or derogatory comments, and personal or political attacks +- Public or private harassment +- Publishing others’ private information, such as a physical or email address, without their explicit permission +- Other conduct which could reasonably be considered inappropriate in a professional setting + +## Enforcement Responsibilities + +Project maintainers are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies within all project spaces, and it also applies when an individual is officially representing the project in public spaces. Examples of representing a project include using an official project email address, posting via an official social media account, or acting as an appointed representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the project team at [INSERT CONTACT EMAIL]. All complaints will be reviewed and investigated promptly and fairly. + +All project maintainers are obligated to respect the privacy and security of the reporter of any incident. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.1, available at https://www.contributor-covenant.org/version/2/1/code_of_conduct.html. From 119434e1691d38a60c5deb22843c97815491133d Mon Sep 17 00:00:00 2001 From: Alina <35198982+AlinaImtiaz018@users.noreply.github.com> Date: Wed, 13 Nov 2024 01:38:11 +0100 Subject: [PATCH 2/4] Update CITATION.cff --- CITATION.cff | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/CITATION.cff b/CITATION.cff index e6b8df027..6e300edb3 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -2,11 +2,10 @@ cff-version: 1.2.0 message: "If you use this software, please cite it as below." title: "face_recognition" version: "1.2.2" -doi: "10.5281/zenodo.1234567" # If a DOI exists; if not, omit this line. authors: - family-names: Geitgey given-names: Adam abstract: "face_recognition is a simple and powerful library in Python for facial recognition, built using dlib's deep learning and machine learning capabilities." keywords: ["face recognition", "machine learning", "Python", "dlib"] repository-code: "https://github.com/ageitgey/face_recognition" -license: "MIT" \ No newline at end of file +license: "MIT" From a7d9c17ceeae8bfcf04bb3daf35a9a55497a654a Mon Sep 17 00:00:00 2001 From: Alina <35198982+AlinaImtiaz018@users.noreply.github.com> Date: Wed, 13 Nov 2024 02:03:10 +0100 Subject: [PATCH 3/4] Add Contributing section to README.md --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 23ac8647d..fd003b765 100644 --- a/README.md +++ b/README.md @@ -402,6 +402,12 @@ Linux users with a GPU (drivers >= 384.81) and [Nvidia-Docker](https://github.co If you run into problems, please read the [Common Errors](https://github.com/ageitgey/face_recognition/wiki/Common-Errors) section of the wiki before filing a github issue. +## Contributing + +We welcome contributions to the `face_recognition` project and appreciate your efforts to improve it! Whether you want to report issues, suggest new features, or submit pull requests, please take a moment to review our [Contribution Guidelines](./CONTRIBUTING.rst) for details on how to get started. + +By contributing, you help us make this project even better and more accessible to the community. + ## Thanks * Many, many thanks to [Davis King](https://github.com/davisking) ([@nulhom](https://twitter.com/nulhom)) From 7cc980c0166977910c8e3207b5e46cadc86472f0 Mon Sep 17 00:00:00 2001 From: Alina <35198982+AlinaImtiaz018@users.noreply.github.com> Date: Wed, 13 Nov 2024 02:52:54 +0100 Subject: [PATCH 4/4] Update CODE_OF_CONDUCT.md --- CODE_OF_CONDUCT.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index f9fbb8bb0..6ab70cac7 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -34,7 +34,7 @@ This Code of Conduct applies within all project spaces, and it also applies when ## Enforcement -Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the project team at [INSERT CONTACT EMAIL]. All complaints will be reviewed and investigated promptly and fairly. +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the project team. All complaints will be reviewed and investigated promptly and fairly. All project maintainers are obligated to respect the privacy and security of the reporter of any incident.