diff --git a/CODEOWNERS b/CODEOWNERS new file mode 100644 index 0000000..8b6465c --- /dev/null +++ b/CODEOWNERS @@ -0,0 +1,13 @@ +# This is a comment. +# Each line is a file pattern followed by one or more owners. + +# These owners will be the default owners for everything in +# the repo. Unless a later match takes precedence, +# @global-owner1 and @global-owner2 will be requested for +# review when someone opens a pull request. +* @MSallermann @amritagos @HaoZeke + +# Order is important; the last matching pattern takes the most +# precedence. When someone opens a pull request that only +# modifies JS files, for example, only @js-owner and not the global +# owner(s) will be requested for a review. diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..35b5167 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,132 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in 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, socio-economic status, +nationality, personal appearance, race, caste, color, 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 + +Community leaders 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. + +Community leaders 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, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail 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 community leaders responsible for enforcement at +[INSERT CONTACT METHOD]. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series of +actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or permanent +ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within the +community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.1, available at +[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. + +Community Impact Guidelines were inspired by +[Mozilla's code of conduct enforcement ladder][Mozilla CoC]. + +For answers to common questions about this code of conduct, see the FAQ at +[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at +[https://www.contributor-covenant.org/translations][translations]. + +[homepage]: https://www.contributor-covenant.org +[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html +[Mozilla CoC]: https://github.com/mozilla/diversity +[FAQ]: https://www.contributor-covenant.org/faq +[translations]: https://www.contributor-covenant.org/translations diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..5d61fa1 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,54 @@ + +# Contributing + +We love pull requests from everyone. By participating in this project, you +agree to abide by the contributor covenant suggested [code of conduct]. + +[code of conduct]: https://github.com/Seldon-code/seldon/blob/main/CODE_OF_CONDUCT.md + +Do make sure to run tests and generally **BE PREPARED** to have your code vetted and +checked. Do **NOT** submit code you would not be prepared to defend or maintain, +unless you are fixing a bug. + +Push to your fork and [submit a pull request][pr]. + +[pr]: https://github.com/Seldon-code/seldon/compare + +At this point you're waiting on us. We like to at least comment on pull requests +within four business days (and, typically, three business day). We may suggest +some changes or improvements or alternatives. + +Some things that will increase the chance that your pull request is accepted: + +- Write tests. +- Follow the commit-style below. + +## Commit Style + +A sample **good commit** is: + +``` +fileName: Thing I did +Some subHeading things + +So this change was to do that thing I thought was good. Also there was this +other person who thought so too, so then I ate a sandwich and we got the code +done. I am writing this but really, honestly, two people did this. + + +Co-authored-by: Joel Doe +``` + +A good commit should have: + +- The name of the file, or the topic or the subject you have changed or the + namespace or the functionality you have added **something:** +- A line describing **something:** +- An _(optional)_ subheading with more details +- An _(optional)_ paragraph or essay on why the change was done and anything else you want to share with the devs. +- **Co-authorship** IS MANDATORY if applicable. Even if you just had a sandwich + with the other person. It won't kill you to share, or to write that. + + + + diff --git a/README.md b/README.md index 4bf24f8..9b27718 100644 --- a/README.md +++ b/README.md @@ -57,3 +57,15 @@ To run the tests, go into the build directory and run the following: ```bash meson test ``` + +## Contributing + +> All contributions are welcome!! + +- We follow a modified [NumPy commit guidelines](https://numpy.org/doc/stable/dev/development_workflow.html#writing-the-commit-message). + + Each commit is to be prefixed by the area of code it affects +- Please run our linter and tests locally to ensure no errors exist +- [Co-author commits](https://github.blog/2018-01-29-commit-together-with-co-authors/) generously + +# License +GNU GPL v3 or later.