From 31bcaa5181dba6794281b904f8f7f15cecdfadbf Mon Sep 17 00:00:00 2001 From: eliashezron Date: Wed, 5 Jun 2024 20:32:14 +0800 Subject: [PATCH 1/2] included contributing and code-of-conduct guidelines --- CODE_OF_CONDUCT.md | 150 +++++++++++++++++++++++++++++++++++++++++++++ CONTRIBUTING.md | 52 ++++++++++++++++ 2 files changed, 202 insertions(+) create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..4d5bada --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,150 @@ +# KARST Code of Conduct + +## Preamble + +The KARST Community was created to foster an open, innovative and inclusive community around open source development. +To clarify expected behaviour in our community we have adopted the Contributor Covenant. This code of conduct +has been adopted by many other open source communities and we feel it expresses our values well. + +## 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 +- Be friendly and patient + +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. + +## Contributing + +Read carefully our Contributing Guidelines to know how to contribute properly in our +project. Members and maintainers must adhere to some rules regarding to pull requests +reviews and creation of issues and pull requests: + +- During code reviews do not comment on coding standards and styles -focus on algorithmical, + structural or naming issues-, help to solve problem. +- When creating an issue or a pull request, follow the templates provided by the repository and + fill in the indicated items correctly. If you do not want to use a template, open a blank issue/PR + and make sure that in its description is not missing any information requested by the templates. Help + the community to get to know your work better. + +make sure your description is not missing any information requested by the templates + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +darlingtonnnam@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..bf1ce36 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,52 @@ +# Contributing to KARST + +The KARST team maintains guidelines for contributing to the KARST project repository. + +### Code of Conduct + +Have you read the [code of conduct](https://github.com/horuslabsio/karst-core/blob/master/CODE_OF_CONDUCT.md)? + +## Bugs and Feature Request + +Before you make your changes, check to see if an [issue](https://github.com/horuslabsio/karst-coreissues) exists already for the change you want to make. + +### Don't see your issue? Open one + +If you spot something new, open an issue using a [template](https://github.com/horuslabsio/karst-core/issues/new/choose). We'll use the issue to have a conversation about the problem you want to fix. + +### Open a Pull Request + +When you're done making changes and you'd like to propose them for review, use the pull request template to open your PR (pull request). + +If your PR is not ready for review and merge because you are still working on it, please convert it to draft and add to it the label `wip` (work in progress). This label allows to filter correctly the rest of PR not `wip`. + +### Do you intend to add a new feature or change an existing one? + +Suggest your change by opening an issue and starting a discussion. + +### Improving Issues and PR + +Please add, if possible, a reviewer, assignees and labels to your issue and PR. + +## DOs and DON'Ts + +Please do: + +- **DO** give priority to the current style of the project or file you're changing even if it diverges from the general guidelines. +- **DO** include tests when adding new features. When fixing bugs, start with adding a test that highlights how the current behavior is broken. +- **DO** especially follow our rules in the [Contributing](https://github.com/horuslabsio/karst-core/master/CODE_OF_CONDUCT.md#contributing) section of our code of conduct. + +Please do not: + +- **DON'T** create a new file without the proper file header. +- **DON'T** fill the issues and PR descriptions vaguely. The elements in the templates are there for a good reason. Help the team. +- **DON'T** surprise us with big pull requests. Instead, file an issue and start a discussion so we can agree on a direction before you invest a large amount of time. + +## Branch Naming + +Branch names must follow `snake_case` pattern. Follow the pattern `//_` when it is possible and add issue reference if applicable. For example: + +- feature/1234_issue_title +- publications/feature/1234_issue_title +- fix/2345_bug_title +- publications/refactor/4567_title From b7acede7a37fe55c07592fcb4e492e1fd3ab7542 Mon Sep 17 00:00:00 2001 From: eliashezron <eliashezron23@gmail.com> Date: Wed, 5 Jun 2024 20:46:46 +0800 Subject: [PATCH 2/2] updated readme --- Readme.md | 11 +++++++++++ SECURITY.md | 10 ++++++++++ 2 files changed, 21 insertions(+) create mode 100644 SECURITY.md diff --git a/Readme.md b/Readme.md index c26e075..dae1725 100644 --- a/Readme.md +++ b/Readme.md @@ -57,3 +57,14 @@ Check out the contract architecture below, and join our [working group](https:// <img width="100%" alt="Screenshot 2024-05-24 at 00 11 16" src="https://github.com/horuslabsio/karst-core/blob/main/img/architecture.png?raw=true"> +## Contributing + +BEFORE you start work on a feature or fix, please read and follow our [contribution guide](https://github.com/horuslabsio/karst-core/blob/master/CONTRIBUTING.md) to help avoid any wasted or duplicate effort. + +## Security + +If you believe you have found a security vulnerability in our code, please report it to us as described in our [security policy](https://github.com/horuslabsio/karst-core/blob/master/SECURITY.md). + +## License + +KARST is an open-source software licensed under the [MIT](https://github.com/horuslabsio/karst-core/blob/master/LICENSE.md). diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..a18cdb3 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,10 @@ +# Security policy + +If you believe you have found a security vulnerability in our code, we encourage you to report it to us as soon as possible. +We ask that you do not publicly disclose any details of the vulnerability until we have had an opportunity to investigate and address it. + +## Reporting a vulnerability + +To report a security vulnerability, go to [Report a vulnerability](darlingtonnnam@gmail.com). This will create a draft advisory. Please provide as much detail as possible including steps to reproduce the issue and any potential impact it may have. + +Alternatively, you can also send an email to darlingtonnnam@gmail.com. We will work to acknowledge your report within 24 hours and will keep you informed throughout our investigation and resolution process. \ No newline at end of file