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.

Sign up for GitHub

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

Jump to bottom

Docs: Document about roles, people and processes #1230

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Open

Docs: Document about roles, people and processes #1230

Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
44dbcfa
First draft of adding a role and people documentation
tordans May 24, 2024
15617bd
Ask ChatGPT to improve the english language
tordans May 24, 2024
db89cf3
Maintenance: Clarify guidelines, add Kyle
tordans May 31, 2024
6cf79d5
Maintenance: Describe how to merge
tordans May 31, 2024
30c4774
Improve wording
tordans Jun 5, 2024
50f0ff7
fix typo
tyrasd Jun 5, 2024
80cb9e8
Docs: Add section on assigning roles
tordans Jun 5, 2024
81464b6
Docs: Add "assign roles" to maintainer role
tordans Jun 6, 2024
817a642
Docs: Update assign roles section
tordans Jun 6, 2024
4e1a225
Docs: Add github labels
tordans Jun 6, 2024
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
89 changes: 89 additions & 0 deletions MAINTENANCE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
# Roles, People, and Processes for Maintaining the Tagging Schema

This document outlines how this project is maintained.

## Roles & People

### Maintainer Role

[Martin](https://github.com/tyrasd) maintains this project as part of his work on the iD Editor project.

The maintainer role includes:
tordans marked this conversation as resolved.
Show resolved Hide resolved
- Having the final say in decisions for the tagging schema.
- Creating releases.
- Updating dependencies.
- Assign roles.

and all the following roles.

Github shows a `(Member)` label next to users with full access to this repository and the organisation.

### Contributor Role
Copy link
Contributor

@matkoniecz matkoniecz Jun 6, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe different name may be better? Github is using "contributor" to refer to anyone who got commit accepted and to anyone who opened a PR (within that PR). This document itself uses contributor a bit below in yet another meaning.

screen10

Maybe "Helper"?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point. Github also uses "collaborator" …

image

I think that badge appeared once I had triage roles but I am not sure if the name changed. I remember that the triage role added a name that suggested to readers that I had more of a maintainer role, which is not true.

Unfortunately https://docs.github.com/en/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization does not explain which badge is added when.

I think to clarify we should add the github badge name to this section so there is a reference.

We might need to test this out by changing my permission @tyrasd

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added the names of the github labels as I understand them ATM. We will need to look for better names of the chapters/roles.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Collaborator" is when your account is added to project and has any rights assignable on github (at least from my understanding/memory).

"First-time contributor" is on PR of someone who has their first PR in repo (not sure is it overriding other labels)

"Contributor" - their changes were accepted into repo (not sure about edge cases like their PR merged that contained no commits they made or commits authored/committed by them being accepted without opening PR etc)


- [Kyle](https://github.com/k-yle) contributes to this project as a volunteer.
- [Tobias](https://github.com/tordans) contributes to this project as a volunteer.

The contributor role includes:
- Reviewing PRs.
- Merging "clear-cut" PRs.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it OK for them to merge own PRs if they seem clear cut for them?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Technically they cannot due to branch protection rules. But lets make it explicit. How about…

Suggested change
- Merging "clear-cut" PRs.
- Merging "clear-cut" PRs by others.


and all the following roles.

Github shows a `(Collaborator)` label next to users with any permission on this repository.

### Triage Role

(No one has the triage role at the moment. Please reach out if you want to help.)

The triage role includes:
- Helping to clarify issues and PRs.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe it can be also clarified that people with no formal triage role are encouraged to do this?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe "Helping to clarify issues and PRs." should be moved altogether to section below?

- Closing issues as duplicates or not planned.

Github shows a `(Collaborator)` label next to users with any permission on this repository.

### Contributors
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note confusion with "Contributor role"


To all contributors, thank you so much for your support! ❤ Especially for:
- Suggesting new presets and fields or updates to the repository.
- Researching and helping with issues and PRs.
- Translating the tagging schema.

Code contributions: [Check this complete list of contributors on GitHub](https://github.com/openstreetmap/id-tagging-schema/graphs/contributors).

Github shows a `(Contributor)` label next to users that previously committed to this repository.

## Processes

### PR Reviews and Merges

- PRs need approval from two people: the author and one or more contributors before being merged.
- Non-"clear-cut" changes need to be merged by the maintainer.
- We might revert merges later if necessary.

**What is a clear-cut change?**

- No or minimal controversial discussion on the change.
- Coding and contribution [guidelines](./GUIDELINES.md) are met.

**How to merge…**

- Usually squash merge PRs to make the history simpler
- Give the merge a meaningful description of the change
- Add labels to the PR to simplify creating the changelog: `new-*`, `add-*`, `bug`

### Releases

There is no set release schedule at the moment, but releases usually occur every other month. After this project is released, the projects that rely on the data need to update and release as well.

### Assigning roles

- The maintainer of the iD editor has traditionally and continues to maintain this project.
- Contributor and triage roles are assigned by the current maintainer of the repository.

## Previous Maintainers

Many thanks to all previous maintainers! ❤

- [Milos](https://github.com/mbrzakovic)
- [Quincy](https://github.com/quincylvania)
- [Bryan](https://github.com/bhousel)
Loading