Skip to content

Commit

Permalink
chore: enable remaining linting rules (#543)
Browse files Browse the repository at this point in the history
  • Loading branch information
dsanders11 authored Jun 8, 2023
1 parent a099ea0 commit 5a2e314
Show file tree
Hide file tree
Showing 32 changed files with 202 additions and 164 deletions.
13 changes: 1 addition & 12 deletions .markdownlint.json
Original file line number Diff line number Diff line change
@@ -1,14 +1,3 @@
{
"extends": "@electron/lint-roller/configs/markdownlint.json",
"blanks-around-fences": false,
"blanks-around-headings": false,
"blanks-around-headers": false,
"blanks-around-lists": false,
"fenced-code-language": false,
"ol-prefix": false,
"no-multiple-blanks": false,
"no-shortcut-reference-links": false,
"no-trailing-spaces": false,
"ul-indent": false,
"ul-style": false
"extends": "@electron/lint-roller/configs/markdownlint.json"
}
31 changes: 16 additions & 15 deletions charter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,23 +37,23 @@ These are our core values, as voted by the maintainers, in order of importance.

## Definitions

* A _maintainer_ is anyone who plays an active role in governance.
* A _collaborator_ is active in the community, but not in governance.
* A _participant_ is anyone who is a maintainer or collaborator.
* A _Working Group_ is a group of maintainers that is formed to take responsibility for certain aspects of the Electron project. Normally these groups will meet regularly but in some cases will only meet as required to fulfill their responsibilities.
* A _chair_ is the acting leader of a Working Group that uses the [Rotating Chair Model](rotating-chair-model.md).
* A [_delegate_](#delegation) is a chosen representative of a Working Group.
* A _maintainer_ is anyone who plays an active role in governance.
* A _collaborator_ is active in the community, but not in governance.
* A _participant_ is anyone who is a maintainer or collaborator.
* A _Working Group_ is a group of maintainers that is formed to take responsibility for certain aspects of the Electron project. Normally these groups will meet regularly but in some cases will only meet as required to fulfill their responsibilities.
* A _chair_ is the acting leader of a Working Group that uses the [Rotating Chair Model](rotating-chair-model.md).
* A [_delegate_](#delegation) is a chosen representative of a Working Group.

## Participation

* [Code of Conduct](../CODE_OF_CONDUCT.md)
* [Using Slack](../policy/slack.md)
* [Triaging Issues](../playbooks/README.md)
* [Using Pull Requests](../policy/pull-requests.md)
* [Code of Conduct](../CODE_OF_CONDUCT.md)
* [Using Slack](../policy/slack.md)
* [Triaging Issues](../playbooks/README.md)
* [Using Pull Requests](../policy/pull-requests.md)

## Working Groups

| Working Group | Repo | Description |
| Working Group | Repo | Description |
|:---------------|:------|-------------|
| Administrative | [wg-administrative](../wg-administrative) | Administrates Governance |
| Community | [wg-community-safety](../wg-community-safety/) | Handles Code of Conduct issues |
Expand All @@ -67,10 +67,11 @@ These are our core values, as voted by the maintainers, in order of importance.
### Responsibilities

All Working Groups have these core responsibilities:
* They shall decide for themselves, and publicly post, their rules, e.g. how decisions are made, when meetings are held, and who may attend.
* They shall choose a model of work to support reaching the Working Group's goals.
* They shall keep meeting notes, including agenda items, discussion points, and outcomes for everyone to review.
* They shall be collaborative and work [in good faith](#core-values) with other Working Groups.

* They shall decide for themselves, and publicly post, their rules, e.g. how decisions are made, when meetings are held, and who may attend.
* They shall choose a model of work to support reaching the Working Group's goals.
* They shall keep meeting notes, including agenda items, discussion points, and outcomes for everyone to review.
* They shall be collaborative and work [in good faith](#core-values) with other Working Groups.

### Meetings

Expand Down
5 changes: 4 additions & 1 deletion charter/rotating-chair-model.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,15 @@ The Rotating Chair Model is a model of a Working Group that appoints a leader to
## Working Group Responsibilities

A Working Group that uses the Rotating Chair Model has an additional core responsibility:

* They shall [select](#chair-terms-and-selection) a rotating chair to [lead](#chair-responsibilities) the group and ensure the Working Group's goals are fulfilled.

## Chair Terms and Selection

The Chair has a term that is written in the Working Group's own charter. By default, that term is four months.

A person is eligible to chair the Working Group if and only if they satisfy all conditions:

1. They wish to serve as chair.
2. They are a member of the Working Group.
3. They are not the chair of more than one other Working Group.
Expand All @@ -36,10 +38,11 @@ Chairs have responsibilities to their Working Group: they ensure that their Work
Chairs have responsibility to all participants in transparently reporting the group's activity.

Chairs also have the following regular duties within their Working Groups:

* Collect agenda items prior to each meeting to ensure a smooth and focused Working Group meeting.
* Ensure that the Working Group is notified of the agenda for the meeting in a timely manner advance of the meeting.
* Attend and lead each Working Group meeting.
* If the chair is unable to attend a meeting, they should appoint another member to lead the meeting in their stead.
* If the chair is unable to attend a meeting, they should appoint another member to lead the meeting in their stead.
* Ensure meeting notes are uploaded to the `governance` repo in the Working Group's respective subdirectory following each meeting.
* Check into persistent issues present on their Working Group's repositories of responsibility (ex. bot failures).
* Ensure that the WG roster list accurately reflects current membership.
Expand Down
6 changes: 3 additions & 3 deletions playbooks/code-of-conduct-violations.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ For first offenses, the process is:
Violation text:

```markdown
[[at-mention]] your comment was deleted as a violation of the {{project code of conduct link}} as it
[[was insulting or derogatory/contained sexualized content/is considered harassment/published others'
personal information/is unprofessional conduct]]. You may consider this an official warning.
{{at-mention}} your comment was deleted as a violation of the {{project code of conduct link}} as it
{{was insulting or derogatory/contained sexualized content/is considered harassment/published others'
personal information/is unprofessional conduct}}. You may consider this an official warning.
```

## More than warnings
Expand Down
56 changes: 33 additions & 23 deletions playbooks/issue-triage.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,50 +95,60 @@ This section outlines several common scenarios, and the responses and labels we
#### Low Quality/Spam

Issue did not fill out the issue template:
* Reply with [`needs-template` response](responses/needs-template.md)

* Reply with [`needs-template` response](responses/needs-template.md)

Issue is asking about a third-party dependency, or app-specific JavaScript code
* Reply with [`not-an-issue` response](responses/not-an-issue.md)
* Close the issue

* Reply with [`not-an-issue` response](responses/not-an-issue.md)
* Close the issue

Issue is transparently spam
* Close the issue (no reply needed)

* Close the issue (no reply needed)

#### Blocked/Needs Info

Issue does not contain adequate information (i.e., no expected behavior or is on an unsupported version of Electron):
* Reply with [`old-version` response](responses/old-version.md), or ask for clarification on missing information
* Add `blocked/needs-info` label

* Reply with [`old-version` response](responses/old-version.md), or ask for clarification on missing information
* Add `blocked/needs-info` label

Issue has no repro:
* Reply with [`blocked-needs-repro` response](responses/blocked-needs-repro.md)
* Add `blocked/needs-repro` label

* Reply with [`blocked-needs-repro` response](responses/blocked-needs-repro.md)
* Add `blocked/needs-repro` label

### Has Repro

Issue does contain enough information and has a repro, but you as a triager don't have time to confirm the repro:
* Add `has-repro-gist` or `has-repro-repo` label
* Add `platform/*` for the affected OS (Mac/Windows/Linux/All)
* Add `status/reviewed` label

* Add `has-repro-gist` or `has-repro-repo` label
* Add `platform/*` for the affected OS (Mac/Windows/Linux/All)
* Add `status/reviewed` label

Issue can be reproduced!
* Add `status/confirmed` label
* Add `platform/*` for the affected OS (Mac/Windows/Linux/All) if not added
* If the issue affects a new version of Electron, add it to the Project Board for the **newest** affected version (i.e. if both 17-x-y and 18-x-y are affected, add it to the 18-x-y Project Board).

* Add `status/confirmed` label
* Add `platform/*` for the affected OS (Mac/Windows/Linux/All) if not added
* If the issue affects a new version of Electron, add it to the Project Board for the **newest** affected version (i.e. if both 17-x-y and 18-x-y are affected, add it to the 18-x-y Project Board).

### Crash Report

Issue details a crash, but has no repro or crash report attached:
* Reply with [`crash-report` response](responses/crash-report.md)
* Add `blocked/needs-info` label
* Add `crash` label

* Reply with [`crash-report` response](responses/crash-report.md)
* Add `blocked/needs-info` label
* Add `crash` label

Issue details a crash and has a crash report attached, but no repro:
* Add `crash` label
* Try running the .dmp file or report through `electron-minidump` or `electron-symbolicate`. If the crash is only a stacktrace, or if you find you need more symbol information, reply with [`crash-report` response](responses/crash-report.md)
* Add `status/reviewed` label

* Add `crash` label
* Try running the .dmp file or report through `electron-minidump` or `electron-symbolicate`. If the crash is only a stacktrace, or if you find you need more symbol information, reply with [`crash-report` response](responses/crash-report.md)
* Add `status/reviewed` label

Issue details a crash, and has both a crash report and a repro:
* Add `crash` label
* Add `has-repro-gist` or `has-repro-repo` label
* Review the repro gist. If the crash can be reproduced, add `status/confirmed` label

* Add `crash` label
* Add `has-repro-gist` or `has-repro-repo` label
* Review the repro gist. If the crash can be reproduced, add `status/confirmed` label
2 changes: 1 addition & 1 deletion playbooks/responses/already-fixed.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
Thanks for reporting this!

This has already been fixed in [insert PR URL here]. It is currently scheduled for release when [release number] reaches Stable.
This has already been fixed in {{insert PR URL here}}. It is currently scheduled for release when {{release number}} reaches Stable.
3 changes: 2 additions & 1 deletion playbooks/responses/crash-report.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,13 @@ action:

Could you please attach a crash dump to help us get more information? You can collect them by adding the following snippet to your main process code, before app.whenReady:

```
```js
const { app, crashReporter } = require('electron')

console.log(app.getPath('crashDumps'))
crashReporter.start({ submitURL: '', uploadToServer: false })
```

Then reproduce the crash, zip up the crash dumps directory and attach it here. I'm adding the `blocked/need-info` label until we have access to the crash dumps.

Thanks in advance! Your help is appreciated.
2 changes: 1 addition & 1 deletion playbooks/responses/duplicate-notification.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ action:

Thanks for taking the time to contribute!

We noticed that this is a duplicate of [Issue URL]. You may want to subscribe there for updates.
We noticed that this is a duplicate of {{Issue URL}}. You may want to subscribe there for updates.

Because we treat our issues list as [the project team's backlog](https://en.wikipedia.org/wiki/Scrum_(software_development)#Product_backlog), we close duplicates to focus our work and not have to touch the same chunk of code for the same reason multiple times. This is also why we may mark something as duplicate that isn't an exact duplicate but is closely related.

Expand Down
2 changes: 1 addition & 1 deletion playbooks/responses/first-warning.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
[[at-mention]] your comment was [[minimized|deleted]] as a violation of [the Electron Code of Conduct](https://github.com/electron/electron/blob/main/CODE_OF_CONDUCT.md). You may consider this an official warning.
{{at-mention}} your comment was {{minimized|deleted}} as a violation of [the Electron Code of Conduct](https://github.com/electron/electron/blob/main/CODE_OF_CONDUCT.md). You may consider this an official warning.

**Please do not interact with the project for 24 hours.** After that, please look through your open issues and edit them to ensure they're entirely on-topic, and we can continue the discussion here about the best way to go forward.
2 changes: 1 addition & 1 deletion playbooks/responses/no-response.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ action:

Thank you for your issue!

We haven't gotten a response to our questions in our comment [insert URL here]. With only the information that is currently in the issue, we don't have enough information to take action. I'm going to close this but don't hesitate to reach out if you have or find the answers we need, we'll be happy to reopen the issue.
We haven't gotten a response to our questions in our comment {{insert URL here}}. With only the information that is currently in the issue, we don't have enough information to take action. I'm going to close this but don't hesitate to reach out if you have or find the answers we need, we'll be happy to reopen the issue.
2 changes: 1 addition & 1 deletion playbooks/responses/not-an-issue.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@ action:
- close issue
---

Thanks for reaching out and logging this issue! Because we treat our issues list as the team's backlog, we close issues that are questions since they don't represent a task needing to be completed. For most questions about Electron there are a lot of options.
Thanks for reaching out and logging this issue! Because we treat our issues list as the team's backlog, we close issues that are questions since they don't represent a task needing to be completed. For most questions about Electron there are a lot of options.

Check out the [Electron community](https://www.electronjs.org/community#boilerplates). There are also a bunch of helpful people in this [Discord](https://discord.gg/electronjs) that should be willing to point you in the right direction. For your question, I'd recommend the Discord - we have many active help channels and mentors, as well as fellow devs, who can help you out.
3 changes: 0 additions & 3 deletions wg-administrative/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,4 @@ It is important that other working groups have autonomy and agency to fulfill th

The AWG is open to welcoming new members. Please note that as a prerequisite, interested parties must manage a substantial investment in the project, including supporting teams that contain regular Electron contributors



## Meeting Schedule

2 changes: 1 addition & 1 deletion wg-administrative/initiatives/OpenJS.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,6 @@ We will strive for unanimous consensus, and failing that will look for majority
- [@cruzerld](https://github.com/cruzerld)
- [@felixrieseberg](https://github.com/felixrieseberg)
- [@groundwater](https://github.com/groundwater)
- [@jkleinsc](https://github.com/jkleinsc) [initial chair]
- [@jkleinsc](https://github.com/jkleinsc) (initial chair)
- [@lee-dohm](https://github.com/lee-dohm)
- [@nornagon](https://github.com/nornagon)
Loading

0 comments on commit 5a2e314

Please sign in to comment.