diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..0fff602 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,128 @@ +# 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, 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 +userunamed981@gmail.com. +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.0, available at +https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. + +Community Impact Guidelines were inspired by [Mozilla's code of conduct +enforcement ladder](https://github.com/mozilla/diversity). + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see the FAQ at +https://www.contributor-covenant.org/faq. Translations are available at +https://www.contributor-covenant.org/translations. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..0ba8bee --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,49 @@ +# Contributing to Reflect +Before you start, we would like to tell you that this project has some differences on coding conventions, even though its based on the LLVM coding convention. + +Here is our coding convention: +- 2 spaces for whitespace (no tabs) +- camelCase for functions/methods +- camelCase for variables +- camelCase for fields +- Fields do not have the `m_` prefix +- PascalCase for class/struct names +- PascalCase for typedefs +- Lowercase for namespace names +- UPPER_SNAKE_CASE for macros + +It's really just LLVM, but with some slight differences. +Alright, now let's get to the main part. + +*Thank you for contributing!* +## Bugs +- Please check for issues regarding your bug. If you have found one, do not open a new issue. + +- Provide a concise title and it should be prefixed with `[BUG]: `. + +- Provide also a clear description, and fill in the blanks if necessary. + +- If it is a security vulnerability, please also prefix `[VULNERABILITY]` behind the other prefix like `[VULNERABILITY] [BUG]: `. + +- You should include as much information as possible, and other things (logs, breakpoint statements, etc.) if possible. And be sure to provide the steps to reproduce it, as well optionally to attach the patched executable (if you can build it, of course) + +- Be sure to use the bug templates, as it can lead to your issue being resolved faster. +## Feature requests + +- Again, please check for issues related to your request. If you found one, please do not open a new one. + +- Provide a concise title with a detailed description if necessary. Please also prefix `[FEATURE REQUEST]: ` to your issue. + +- If the feature request is purely cosmetic and does not change the overall codebase, please do not open a new issue. Most likely, we may resolve it soon. If not, contact the developers about this. + +- The feature request must include the public API and other technical things to ensure compliance with your issue. + +- You should also attach logs and other info as well as the modified executable and source code you deem satisfactory. +## Documentation + +- If you want to contribute to the documentation (either code documentation or general), you can open a new issue. + +- Provide a detailed description, and be sure to prefix `[DOCUMENTATION]:` into your title. + +- We are very relaxed on documentation. As long as it is not against the code of conduct and is reviewed, you are good to go. +