-
-
Notifications
You must be signed in to change notification settings - Fork 58
Fix typos and grammar in CONTRIBUTING.md #952
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
Open
Scarmonit
wants to merge
1
commit into
json-schema-org:main
Choose a base branch
from
Scarmonit:patch-1
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,82 +1,54 @@ | ||
| # Guidelines for contributing to the JSON Schema Community | ||
|
|
||
| We invite you to join us working on JSON Schema. | ||
|
|
||
| The fastest way to get involved and become active in the community is to join the `#contribute` channel in our Slack server at https://json-schema.org/slack. | ||
|
|
||
| If you have suggestions on how to improve our community, please do check out our [Community Discussions](https://github.com/json-schema-org/community/discussions), and start a new discussion. | ||
|
|
||
| ### Types of contributions | ||
|
|
||
| JSON Schema is a community that lives on its contributors. As we grow, we need more people to help others. You can contribute in many ways, either in the specification development or in the wider ecosystem. | ||
|
|
||
| Here are some areas where you can contribute: | ||
| * 🌱 [Specification development](https://github.com/json-schema-org/json-schema-spec) | ||
| * 🐞 Reporting Bugs | ||
| * 💡 Issues and feature requests | ||
| * 🧐 Reviewing PRs | ||
| * ❓ Answer questions | ||
| * 🙏 Join discussions and provide feedback | ||
| * 🛠️ [Add new JSON Schema tooling](https://github.com/json-schema-org/website/blob/main/CONTRIBUTING.md#%EF%B8%8F-add-a-new-implementation) | ||
| * 🚀 [Adding a new Adopter](https://github.com/json-schema-org/community/blob/main/ADOPTERS.md) | ||
| * ✍️ [Publish a blog post](https://github.com/json-schema-org/website/blob/main/CONTRIBUTING.md#%EF%B8%8F-publish-a-blog-post) | ||
| * 📈 [Publish a case study](https://github.com/json-schema-org/website/blob/main/CONTRIBUTING.md#-publish-a-case-study) | ||
| * 📋 [Improving The Documentation](https://github.com/json-schema-org/website/blob/main/CONTRIBUTING.md#-improving-the-documentation) | ||
| * 🏗 [Website development](https://github.com/json-schema-org/website/blob/main/CONTRIBUTING.md#-improving-the-website) | ||
| * 🎨 [Improving The Design](https://github.com/json-schema-org/website/blob/main/CONTRIBUTING.md#-improving-the-design) | ||
| * 😍 [Collaborating with Community Management tasks](https://github.com/json-schema-org/community) | ||
| * 🚀 [Adding a new Adopter](https://github.com/json-schema-org/community/blob/main/ADOPTERS.md) | ||
| * 🌈 Other JSON Schema projects you can contribute to: | ||
|
|
||
| * 🌱 [Specification development](https://github.com/json-schema-org/json-schema-spec) | ||
| * 🐞 Reporting Bugs | ||
| * 💡 Issues and feature requests | ||
| * 🧐 Reviewing PRs | ||
| * ❓ Answer questions | ||
| * 🙏 Join discussions and provide feedback | ||
| * 🛠️ [Add new JSON Schema tooling](https://github.com/json-schema-org/website/blob/main/CONTRIBUTING.md#%EF%B8%8F-add-a-new-implementation) | ||
| * 🚀 [Adding a new Adopter](https://github.com/json-schema-org/community/blob/main/ADOPTERS.md) | ||
| * ✍️ [Publish a blog post](https://github.com/json-schema-org/website/blob/main/CONTRIBUTING.md#%EF%B8%8F-publish-a-blog-post) | ||
| * 📈 [Publish a case study](https://github.com/json-schema-org/website/blob/main/CONTRIBUTING.md#-publish-a-case-study) | ||
| * 📋 [Improving The Documentation](https://github.com/json-schema-org/website/blob/main/CONTRIBUTING.md#-improving-the-documentation) | ||
| * 🏗 [Website development](https://github.com/json-schema-org/website/blob/main/CONTRIBUTING.md#-improving-the-website) | ||
| * 🎨 [Improving The Design](https://github.com/json-schema-org/website/blob/main/CONTRIBUTING.md#-improving-the-design) | ||
| * 😍 [Collaborating with Community Management tasks](https://github.com/json-schema-org/community) | ||
| * 🚀 [Adding a new Adopter](https://github.com/json-schema-org/community/blob/main/ADOPTERS.md) | ||
| * 🌈 Other JSON Schema projects you can contribute to: | ||
| * [JSON Schema Conference](https://github.com/json-schema-org/conference/blob/main/CONTRIBUTING.md). | ||
| * [Tour of JSON Schema](https://github.com/json-schema-org/tour/blob/main/CONTRIBUTING.md). | ||
| * [JSON Schema Landscape](https://github.com/json-schema-org/landscape/blob/main/CONTRIBUTING.md). | ||
| * [JSON Schema Ecosystem](https://github.com/json-schema-org/ecosystem/blob/main/CONTRIBUTING.md). | ||
|
|
||
| * 🌐 Other JSON Schema Ecosystem Projects you can contribute to: | ||
| * 🌐 Other JSON Schema Ecosystem Projects you can contribute to: | ||
| * [Bowtie](https://github.com/bowtie-json-schema/bowtie) development. | ||
| * Contribute to any well mantained JSON Schema implementation. | ||
|
|
||
| * Contribute to any well maintained JSON Schema implementation. | ||
| #### Community management tasks | ||
|
|
||
| To get involved in the Community management tasks, please join the [`#community-mgmt` slack channel](https://json-schema.slack.com/archives/C0209BTU2UQ). | ||
|
|
||
| ### Key "Architectural" decisions | ||
|
|
||
| In most repositories, we would like to utilise [Architectural Decision Records (ADRs)](https://adr.github.io/) to help us work effectively. | ||
|
|
||
| [We agreed](https://github.com/json-schema-org/community/blob/main/docs/adr/2021-05-17-use-markdown-architectural-decision-records.md) to do this and documented this decision as an ADR: ([Community PR 21](https://github.com/json-schema-org/community/pull/21)). | ||
|
|
||
| ADRs are a lightweight way to record and track significant or noteworthy decisions and changes made in a project, including the considerations and people that lead to the decision. | ||
|
|
||
| When a new Issue or Pull Request is created, submitters and maintainers should consider if the proposal or proposed change is significant or noteworthy. The submitter may assert this, however deciding if something is significant or noteworthy shall be at the discretion of the maintainer/s at hand. One maintainers preference to consider the change significant or noteworthy is sufficient to outweigh preference against, airing on the side of caution. | ||
|
|
||
| When a new Issue or Pull Request is created, submitters and maintainers should consider if the proposal or proposed change is significant or noteworthy. The submitter may assert this, however deciding if something is significant or noteworthy shall be at the discretion of the maintainer/s at hand. One maintainer's preference to consider the change significant or noteworthy is sufficient to outweigh preference against, erring on the side of caution. | ||
| In the situation where an ADR may seem not to have an associated change at the same time (within the same Pull Request), we should consider if any documentation should be updated as a result. | ||
|
|
||
| In some situaitions, it may be appropriate to produce an ADR retrospectivly, in order to document recent decisions made before the use of ADRs was established. This will be at the discretion of the maintainers. | ||
|
|
||
| In some situations, it may be appropriate to produce an ADR retrospectively, in order to document recent decisions made before the use of ADRs was established. This will be at the discretion of the maintainers. | ||
| ### Issues | ||
|
|
||
| When creating an Issue, the submitter should assert if they believe the resolution of the Issue is likely to result in a significant or noteworthy change. This can only be expected for repositories that use ADRs and have appropriate issue templates in place. | ||
|
|
||
| A maintainer may add a label `adr-required` to the issue. | ||
|
|
||
| ### Pull Requests | ||
|
|
||
| When creating a Pull Request, the submitter should assert if they believe merging the PR will need an ADR or not. If the submitter is not a maintainer, a maintainer will confirm if one is required before merging by adding the appropriate label, either `adr-required` or `adr-not-required`. | ||
|
|
||
| If a Pull Request has an issue associated with it (through the associated issue GitHub feature), it should inherit present `adr-required` labels. | ||
|
|
||
| Once an ADR is part of a pull request which is labelled with `adr-required`, the label `adr-included` can be added. | ||
|
|
||
| (It would be great if some parts of this could be automated. Specification and full workflow required.) | ||
|
|
||
|
|
||
| The process is designed to be lightweight, and a template is provided for ease of use. | ||
|
|
||
| ### Triage | ||
|
|
||
| Please check the [triage process](https://github.com/json-schema-org/.github/blob/main/TRIAGE.md) to learn how we review and label incoming issues . | ||
|
|
||
| Please check the [triage process](https://github.com/json-schema-org/.github/blob/main/TRIAGE.md) to learn how we review and label incoming issues. | ||
| ### Feedback | ||
|
|
||
| Feedback on this process can be made informally through our [Slack server](https://json-schema.org/slack) and formally using our [Community Discussions](https://github.com/json-schema-org/community/discussions). | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Duplicate entry detected. The 'Adding a new Adopter' item appears twice in the list (lines 16 and 23). Consider removing one of these duplicate entries.