Skip to content

Commit

Permalink
Merge pull request #377 from nathan-weinberg/mdlint
Browse files Browse the repository at this point in the history
docs: change markdown lint to enforce 120 char limit
  • Loading branch information
cybette authored Sep 30, 2024
2 parents 137c00d + 34f9aa0 commit df59e42
Show file tree
Hide file tree
Showing 16 changed files with 1,089 additions and 644 deletions.
5 changes: 4 additions & 1 deletion .markdownlint-cli2.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
# SPDX-License-Identifier: Apache-2.0

config:
line-length: false
line-length:
line_length: 120
tables: false
code_blocks: false
no-emphasis-as-header: false
first-line-heading: false
code-block-style: false
Expand Down
4 changes: 4 additions & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"printWidth": 120,
"proseWrap": "always"
}
81 changes: 34 additions & 47 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,78 +2,65 @@

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

## Our Standards

Examples of behavior that contributes to creating a positive environment
include:
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
- 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
- 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](https://github.com/instructlab/community/blob/main/MAINTAINERS.md) 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](https://github.com/instructlab/community/blob/main/MAINTAINERS.md) 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.
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 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 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.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the [Code of Conduct Committee][committee]. 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.
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the [Code of Conduct
Committee][committee]. 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.
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.

You can find the [Code of Conduct Committee member email addresses listed here][committee].

## 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 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>
For answers to common questions about this code of conduct, see <https://www.contributor-covenant.org/faq>

[committee]: https://github.com/instructlab/community/blob/main/CODE_OF_CONDUCT_COMMITTEE.md
28 changes: 18 additions & 10 deletions CODE_OF_CONDUCT_COMMITTEE.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,28 @@
# Filing a Code of Conduct Violation Report

We take reports of violations to our project [Code of Conduct](https://github.com/instructlab/community/blob/main/CODE_OF_CONDUCT.md) with the utmost seriousness and will act upon them as quickly as possible.
We take reports of violations to our project
[Code of Conduct](https://github.com/instructlab/community/blob/main/CODE_OF_CONDUCT.md) with the utmost seriousness and
will act upon them as quickly as possible.

To report a Code of Conduct violation to our Code of Conduct Committee, you may reach out to us by email at [coc@instructlab.ai](mailto:coc@instructlab.ai). The email will be read and acted upon by our Code of Conduct Committee members.
To report a Code of Conduct violation to our Code of Conduct Committee, you may reach out to us by email at
[coc@instructlab.ai](mailto:coc@instructlab.ai). The email will be read and acted upon by our Code of Conduct Committee
members.

If you experience a Code of Conduct violation in our InstructLab Slack workspace, please follow the [instructions in our moderation guide](https://github.com/instructlab/community/blob/main/InstructLab_SLACK_MODERATION_GUIDE.md#reporting-abuse) to get immediate help in Slack.
If you experience a Code of Conduct violation in our InstructLab Slack workspace, please follow the
[instructions in our moderation guide](https://github.com/instructlab/community/blob/main/InstructLab_SLACK_MODERATION_GUIDE.md#reporting-abuse)
to get immediate help in Slack.

As part of our follow up on your report, we would like to contact you for further discussion. If you would prefer not to engage beyond reporting the matter to the committee, please let us know that as part of your submission. We will respect your request.
As part of our follow up on your report, we would like to contact you for further discussion. If you would prefer not to
engage beyond reporting the matter to the committee, please let us know that as part of your submission. We will respect
your request.

## Code of Conduct Committee Members

The current members of the CoCC are:

* [Cara Delia](https://github.com/caradelia), Red Hat
* [Carol Chen](https://github.com/cybette), Red Hat
* [Leslie Hawthorn](https://github.com/lhawthorn), Red Hat
* [JJ Ashgar](https://github.com/jjasghar), IBM
* [Joe Sepi](https://github.com/joesepi), IBM
* [Maureen McElaney](https://github.com/mmcelaney), IBM
- [Cara Delia](https://github.com/caradelia), Red Hat
- [Carol Chen](https://github.com/cybette), Red Hat
- [Leslie Hawthorn](https://github.com/lhawthorn), Red Hat
- [JJ Ashgar](https://github.com/jjasghar), IBM
- [Joe Sepi](https://github.com/joesepi), IBM
- [Maureen McElaney](https://github.com/mmcelaney), IBM
Loading

0 comments on commit df59e42

Please sign in to comment.