Skip to content

Commit

Permalink
Adding code of conduct, contributing guide, and security policy.
Browse files Browse the repository at this point in the history
  • Loading branch information
simonkernel committed Apr 11, 2022
1 parent 0fa9b17 commit 316ee6a
Show file tree
Hide file tree
Showing 4 changed files with 166 additions and 3 deletions.
76 changes: 76 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to make 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.

## Our Standards

Examples of behavior that contributes to creating a positive environment
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

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/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
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Our 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.

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.

## Scope

This Code of Conduct applies within all project spaces, and it also applies when
an individual is representing the project or its community in public spaces.
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.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at [email protected]. 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.

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.

## 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

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq
55 changes: 55 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# Contributing

We appreciate any and all contributions. Before contributing, please read our [code of conduct](CODE_OF_CONDUCT.md).

## Chat

If you are here, you are likely part of the Kernel and you should join the [#kernel-building-kernel](https://app.slack.com/client/T016DS66R99/C031ES44SA3) Slack channel.

## Submitting an issue

Feel free to submit an issue through the issue tracker.

## Submitting a pull request

For non-trivial changes, please first seek a conversation to avoid any unnecessary work.

## Developing

_Node_: Check that Node is [installed](https://nodejs.org/en/download/) with version `>= 16.8.0`. You can check this with `node -v`.

_Yarn_: Make sure that Yarn 1 is [installed](https://classic.yarnpkg.com/en/docs/install) with version >= `1.22.0`.

### Setup

Fork the repo to your GitHub account.

### Branch organization

All changes should be submitted against the main branch. The goal is to maintain a healthy tip of the branch with all tests passing and no breaking changes. Potentially breaking changes or experimental features should be behind a feature flag.


### Code organization

This is a [monorepo](https://danluu.com/monorepo/) using `yarn workspaces` with each workspace in the customary `packages` folder.

### Creating a new app

Look at `packages/admin` and copy the necessary config files. Consider contributing by adding a [custom template](https://create-react-app.dev/docs/custom-templates/) to make this process easier.

### Running the server locally

The `storage` service currently needs to connect to a Google Cloud Storage bucket. Consider contributing by adding a version by adding a [storage service](https://github.com/simonkernel/kernel-services/blob/main/packages/storage/src/services/storage.js) backed by a local file system instead.

### Running an app

This repo uses `workspaces` to manage local dependencies. From the root of the repo, this is how you start the `admin` app:

```
yarn workspace @kernel/admin start
```

### Running tests

TBD

15 changes: 12 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,13 @@
# kernel-services
Implementation of Kernel services
# Kernel Services

Design Doc: [link](https://bit.ly/3htNTcS)
Kernel is an educational community that learns together how to create with care.

The purpose of Kernel Services is to serve the Kernel community and make its infrastructure available for any other community of care.

## Overview

Please read our [code of conduct](CODE_OF_CONDUCT.md)

If you would like to contribute, read our [contributing](CONTRIBUTING.md) guide.

If you have discovered a security issue, please read [security](SECURITY.md).
23 changes: 23 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Security policy

## Promise

At Kernel, we aim to provide our users with a safe and secure environment. We welcome any contribution from external security researchers.

## Scope

If you believe you have found a security issue in any software, service, or website governed by Kernel, we encourage you to notify us.

Our intention is to help improve the Web by applying best practices learned over the past two decades and combine them with new emerging technology in cryptography and blockchain.

It may not always be obvious whether an issue should be reported as a bug or a security issue. When in doubt, please report it as a security issue first.

## Reporting a Vulnerability

If you have identified a security issue with any of the code or its dependencies, you can report it by sending an email to [email protected].

Please include a proof-of-concept of the exploit, or any other pointers that can help us assess the risk level.

---

Thank you for helping to keep the Kernel secure.

0 comments on commit 316ee6a

Please sign in to comment.