Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: initial documents #1

Merged
merged 10 commits into from
Jul 23, 2021
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,9 @@ This Code of Conduct applies both within project spaces and in public spaces whe

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project lead <<EMAIL TO BEN???>>. The project team will review and investigate all complaints, and will respond in a way that it deems 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.
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project lead report@jsonschema.dev.

The project team will review and investigate all complaints, and will respond in a way that it deems 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.

Expand Down
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,24 @@
<em>Help and clarify how JSON Schema can be interpreted from validation rules to data definition. This extends to how those data definitions can be represented in any programming language</em>
</p>


**The project is only first getting started**

## Charter
To help explain the process, the project, the SIG and the community, in terms of how they all relate, please refer to the [charter](./charter.md).

## Code of Conduct
Respect each other. Choose empathy over judgement. Act according to the [Code of Conduct](./CODE_OF_CONDUCT.md).

## Getting involved
If you want to review changes, creating documentation, help form suggestions or take charge in figuring out a specific task, we welcome any way you want to get involved.

If you find an issue you would like to work on you can drop a comment, ask questions or discuss the approaches. Or if you see we are missing specific things feel free to create new issues.

We have a dedicated slack channel in the JSON Schema slack - join here: https://json-schema.slack.com/archives/C028A3HTY2X.

You can use this channel if you don't know where to get started, want to hear peoples upon on dilemmas, or in general hang out.

## Contributing
In case contributions are for changing content on git, please refer to [git workflow](./git_workflow.md).

Expand Down
2 changes: 2 additions & 0 deletions charter.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ Help and clarify how JSON Schema can be interpreted from validation rules to dat

Implementations are neither in nor out of scope for the project, but it is not a high prioritization.

A test suite is expected to be produced along side the work, to better discuss and formulate specific cases.

## Section 2: Relationship with JSON Schema organization.

The project is not directly involved with the actual JSON Schema specification development, however contributors may be contributors of both. The JSON Schema organization and community may provide guidance and review on vocabulary proposals and proposed releases. It is expected that this project and resulting artifacts will be maintained by teams other than those part of the JSON Schema organization.
Expand Down