diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 000000000..af9867ade --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1,9 @@ + +# bolthur Project Codeowners + +# 1. Codeowners must always be teams, never individuals +# 2. PRs touching any code with a codeowner must be signed off by at least one +# person on the code owner team. + +# Global code owner +* @bolthur/core diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md index 95b55e22a..aa6878acb 100644 --- a/.github/CODE_OF_CONDUCT.md +++ b/.github/CODE_OF_CONDUCT.md @@ -1,73 +1,133 @@ + # 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. +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 creating a positive environment -include: +Examples of behavior that contributes to a positive environment for our +community 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 +* 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 by participants include: +Examples of unacceptable behavior include: -* The use of sexualized language or imagery and unwelcome sexual attention or - advances -* Trolling, insulting/derogatory comments, and personal or political attacks +* 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 electronic - address, without explicit permission +* 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 -## Our Responsibilities +## Enforcement 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. +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. -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. +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 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. +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 by contacting \@Dreaded-Gnu. 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. +reported to the community leaders responsible for enforcement at +[conduct.kernel@example.com](mailto:conduct.kernel@example.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 -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. +**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 1.4, -available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html +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/.github/ISSUE_TEMPLATE/1-bug-report.md b/.github/ISSUE_TEMPLATE/1-bug-report.md new file mode 100644 index 000000000..6e14d9cab --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1-bug-report.md @@ -0,0 +1,52 @@ +--- +name: "\U0001F41B Bug report" +about: Create a report to help us improve +title: '' +labels: bug +assignees: '' + +--- + + + +* **Version/Revision**: +* **Platform**: + +### What steps will reproduce the bug? + + + +### How often does it reproduce? Is there a required condition? + +### What is the expected behavior? + + + +### What do you see instead? + + + +### Additional information + + diff --git a/.github/ISSUE_TEMPLATE/2-feature-request.md b/.github/ISSUE_TEMPLATE/2-feature-request.md new file mode 100644 index 000000000..9e4e35e66 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2-feature-request.md @@ -0,0 +1,23 @@ +--- +name: "\U0001F680 Feature request" +about: Suggest an idea for this project +title: '' +labels: enhancement +assignees: '' + +--- + + + +**Is your feature request related to a problem? Please describe.** +Please describe the problem you are trying to solve. + +**Describe the solution you'd like** +Please describe the desired behavior. + +**Describe alternatives you've considered** +Please describe alternative solutions or features you have considered. diff --git a/.github/ISSUE_TEMPLATE/3-question.md b/.github/ISSUE_TEMPLATE/3-question.md new file mode 100644 index 000000000..a25eede3b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/3-question.md @@ -0,0 +1,14 @@ +--- +name: "\u2049 Question" +about: Ask a question regarding the project +title: '' +labels: question +assignees: '' + +--- + + +* **kernel**: +* **Scope ( kernel, library, driver, other? )**: + + diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 952a553be..000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -name: Bug Report -about: Something doesn't work as expected? Tell us about it ---- - -## Describe the bug - -A clear and concise description of what the bug is. - -## To Reproduce - -Steps to reproduce the behavior: - -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -## Expected behavior - -A clear and concise description of what you expected to happen. - -## Screenshots - -If applicable, add screenshots to help explain your problem. - -## Necessary information (please complete the following information) - -- Version: [e.g. 0.1] -- Device: [Used real device] -- Emulator: [Used emulator including launch command] - -## Additional context - -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..7d29c78c3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: false +#contact_links: +# - name: ⁉️ Need help with Node.js? +# url: https://github.com/nodejs/help +# about: Please file an issue in our help repo. +# - name: 🌐 Found a problem with example.com? +# url: https://github.com/bolthur/bolthur.github.io/issues/new/choose +# about: Please file an issue in the bolthur website repo. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index d188e6cc1..000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Feature Request -about: Suggest a new feature or improvement ---- - -## Is your feature request related to a problem? Please describe. - -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -## 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 deleted file mode 100644 index ee408b02e..000000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,21 +0,0 @@ -Please do not update the README or CHANGELOG, we will do this automatically before release. - -## General - -- [] Updates the Documentation -- [] Adds a new feature -- [] Fixes a bug - -Closes # - -## Checklist - -- [] issue exists for made changes -- [] tests still pass -- [] new tests written and passing / old tests updated with new scenario(s) - -## Changes - -- change 1 -- change 2 -- change 3 diff --git a/.github/PULL_REQUEST_TEMPLATE/1-finished.md b/.github/PULL_REQUEST_TEMPLATE/1-finished.md new file mode 100644 index 000000000..3e987ca6e --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/1-finished.md @@ -0,0 +1,34 @@ +--- +name: Completely done pull request +about: Pull request that has been tested across all platforms +title: '' + +--- + +Please do not update the README or CHANGELOG, this will be done automatically +before a new release. + +## General + +- [ ] Updates the Documentation +- [ ] Adds a new feature +- [ ] Fixes a bug + +Closes # + +## Checklist + +- [ ] Issue exists for made changes +- [ ] `cppcheck` passes without error, when executing `make cppcheck` +- [ ] Change has been tested on provided platforms + + + +## Changes + +- change 1 +- change 2 +- change 3 diff --git a/.github/PULL_REQUEST_TEMPLATE/2-assistance.md b/.github/PULL_REQUEST_TEMPLATE/2-assistance.md new file mode 100644 index 000000000..9daad4c2b --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/2-assistance.md @@ -0,0 +1,38 @@ +--- +name: Pull request with assistance +about: Pull request that needs further testing on different platforms or any other assistance +title: '' + +--- + +Please do not update the README or CHANGELOG, this will be done automatically +before a new release. + +## General + +- [ ] Updates the Documentation +- [ ] Adds a new feature +- [ ] Fixes a bug + +Closes # + +## Checklist + +- [ ] Issue exists for made changes +- [ ] `cppcheck` passes without error, when executing `make cppcheck` + + + +## Assistance + +- [ ] Needs testing on platform `ABC` +- [ ] Needs testing on platform `DEF` + +## Changes + +- change 1 +- change 2 +- change 3 diff --git a/.github/SECURITY.md b/.github/SECURITY.md new file mode 100644 index 000000000..4948da882 --- /dev/null +++ b/.github/SECURITY.md @@ -0,0 +1,44 @@ + +# Security Policies and Procedures + +This document outlines security procedures and general policies for the `bolthur` +project. + +* [Reporting a Bug](#reporting-a-bug) +* [Disclosure Policy](#disclosure-policy) +* [Comments on this Policy](#comments-on-this-policy) + +## Reporting a Bug + +The `bolthur` team and community take all security bugs in `bolthur` seriously. +Thank you for improving the security of `bolthur`. We appreciate your efforts +and responsible disclosure and will make every effort to acknowledge your +contributions. + +Report security bugs by emailing the lead maintainer at +[conduct.kernel@example.com](mailto:conduct.kernel@example.com). + +The lead maintainer will acknowledge your email, and will send a more detailed +response indicating the next steps in handling your report. After the initial +reply to your report, the security team will endeavor to keep you informed of +the progress towards a fix and full announcement, and may ask for additional +information or guidance. + +Report security bugs in third-party modules to the person or team maintaining +the module. + +## Disclosure Policy + +When the security team receives a security bug report, they will assign it to a +primary handler. This person will coordinate the fix and release process, +involving the following steps: + +* Confirm the problem and determine the affected versions. +* Audit code to find any potential similar problems. +* Prepare fixes for all releases still under maintenance. These fixes will be + released as fast as possible. + +## Comments on this Policy + +If you have suggestions on how this process could be improved please submit a +pull request. diff --git a/.github/SUPPORT.md b/.github/SUPPORT.md new file mode 100644 index 000000000..bdd224e1b --- /dev/null +++ b/.github/SUPPORT.md @@ -0,0 +1,9 @@ +# Support + +There are a bunch of ways to get help with your issues. + +* Open a GitHub issue in the respective GitHub repository + +