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

Onboarding repository gazetteer #79

Closed
18 of 24 tasks
birkskyum opened this issue Aug 10, 2022 · 2 comments
Closed
18 of 24 tasks

Onboarding repository gazetteer #79

birkskyum opened this issue Aug 10, 2022 · 2 comments
Labels
onboarding A checklist for the new repository joining MapLibre project.

Comments

@birkskyum
Copy link
Member

birkskyum commented Aug 10, 2022

WIP

https://github.com/birkskyum/gazetteer moved to https://github.com/maplibre/gazetteer

Motivation

We currently rely on an abandoned mapbox library, with no way to maintain it: https://github.com/mapbox/gazetteer

Acceptance

  • Any two board members must agree to accept a new repository.
    Approved by: <@user1> <@user2>

Licensing

  • BSD-2, so smilar to MIT - The repo license is BSD-3 or MIT.
    Repos may allow dual-licensing under other open source licenses, e.g. MIT OR Apache.
  • No, because none of our libraries have this - The repo contains Copyright (c) <year> MapLibre contributors in license file(s) and in the readme.

Special files

  • /README.md
    Description, link to the main maplibre.org page, name of the OSM-US Slack channel for discussions and an invite link, etc
  • /LICENSE
    Dual-licensed repos may have additional files like LICENSE-MIT and LICENSE-APACHE
  • /CONTRIBUTING.md
  • The repo has Pull Request and Issue Templates in /.github dir.
  • The repo has /.github/FUNDING.yml file copied from maplibre-gl-js/funding
  • /CODE_OF_CONDUCT.md
    This file should only link to our primary code of conduct. Use this markup for consistency:
    # Contributor Covenant
    [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](https://github.com/maplibre/maplibre/blob/main/CODE_OF_CONDUCT.md)

Repo Settings

General page

  • [Features] Disable unused features like wiki.
  • [Features] Enable Sponsorships checkbox (see also FUNDING.yaml above).
  • [Features] Enable Preserve this repository.
  • [Pull Requests] Community is encouraged to use squash merge. Disable other merge types if possible.
  • [Pull Requests] Enable Automatically delete head branches.

Access

  • The repo has at least one admin who is ideally not part of the Governing Board: <@user>

Branches

  • The primary branch is named main.
  • Set up branch rules to require CI pass and an approval before merge.
    For smaller projects it might be OK to ignore this rule.

Miscelaneous

  • The repo must not have any personal branches.
    All work should be done on forks and submitted via PRs, including by the admins.
  • Repo has a proper GitHub description and an optional web site
    Use the gear icon in the upper right corner of the repo page.
  • CI automatically runs on all pull requests before merging using GitHub actions
  • Grant admin rights to the board members and automation accounts for packages
    • npmjs.com: package settings / invite: maplibreorg nyurik klokan lseelenbinder wipfli
    • crates.io: package settings / add owner: nyurik klokan lseelenbinder wipfli

Community

  • The new repo has been announced in the #maplibre OSMUS slack channel.
  • The new repo has been announced in the next monthly meeting of the Technical Steering Committee.
  • The new repo has been announced in the @maplibre twitter.
@birkskyum birkskyum added the onboarding A checklist for the new repository joining MapLibre project. label Aug 10, 2022
@birkskyum birkskyum changed the title Onboarding repository [repo] Onboarding repository gazetteer Aug 10, 2022
@wipfli
Copy link
Member

wipfli commented Feb 6, 2023

@birkskyum what is the status on gazetteer?

@birkskyum
Copy link
Member Author

It stalled a bit - didn't know if there was interest in proceeding.

@birkskyum birkskyum closed this as not planned Won't fix, can't repro, duplicate, stale Oct 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
onboarding A checklist for the new repository joining MapLibre project.
Projects
None yet
Development

No branches or pull requests

2 participants