From 4e26492f99ba264d77c3d600132026d6f8d2684d Mon Sep 17 00:00:00 2001 From: Sasha Romijn Date: Wed, 12 Jun 2024 17:24:40 +0200 Subject: [PATCH] Add contribution policy --- CONTRIBUTING.md | 38 ++++++++++++++++++++++++++++++++++++++ README.md | 4 +++- docs/index.md | 2 +- 3 files changed, 42 insertions(+), 2 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..1eac64f --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,38 @@ +## Contributions and credit policy + +I welcome good faith contributions to this checklist. +However, it is intentionally opiniated, and I may refuse contributions for no other reason than that do not align with my views. +I also try to balance level of detail and thoroughness, while avoiding an excessively long list. +Sometimes references to third party sources are more fitting. + +I also welcome edits to improve clarity, grammar, or spelling. +I discourage non-trivial contributions made through automation, such as using an LLM to rewrite prose. +Try to keep your pull requests a reasonable size, for example do not mix a general style change with adding new items to the list. + +To contribute changes to the checklist, create a pull request against the [GitHub repository](https://github.com/mxsasha/lessobviouschecklist) and include an edit to add your name to the [AUTHORS](https://github.com/mxsasha/lessobviouschecklist/blob/main/AUTHORS.md) file in your pull request. +If you contribute in ways other than changing the list, please also create a pull request to add yourself to the AUTHORS file. +If you don't know how to make a pull request, please contact me. +Adding yourself to the AUTHORS file is optional, you may choose to omit this. + +I aim to review and act on all pull requests within one month of their submission. +If I do not, please contact me. +If I decide to edit your contribution, I will check it in with your name as the primary author, and me as a secondary author. +If the contribution a collaborative effort, all collaborators can be included in the AUTHORS file and included as additional authors in the commit. + +If you notice that credit has been recorded incorrectly, please contact me. +I aim to respond within one month. + +Your credits and/or your contributions may be removed or rejected if you violate this project's Code of Conduct. + +This policy also applies to itself. + +### Naming convention + +Names for credit are whatever name the person being credited prefers. +I accept any UTF-8 string of reasonable length as a name. +If a person's name has changed, please create a pull request editing the credits section of this document together with the git .mailmap file (if applicable). +Ireserve the right to reject names that appear to be chosen with some goal other than identifying the contributor. + +## Credits + +This policy was constructed using the [contributions and credits policy guide](https://github.com/contribution-credit/policy) created by members of the RIPE Open Source Working Group. For a full list of contributors to that guide, see https://github.com/contribution-credit/policy/blob/main/CREDITS.md diff --git a/README.md b/README.md index b9fb135..5e97958 100644 --- a/README.md +++ b/README.md @@ -2,4 +2,6 @@ This is a checklist of less obvious things for conference organisers that help build amazing, wonderful, welcoming and inclusive events. -[Read it on lessobvious.cc](https://lessobvious.cc/) +* [Read it on lessobvious.cc](https://lessobvious.cc/) +* [Contribution guide](https://github.com/mxsasha/lessobviouschecklist/blob/main/CONTRIBUTING.md) +* [Credits](https://github.com/mxsasha/lessobviouschecklist/blob/main/AUTHORS.md) diff --git a/docs/index.md b/docs/index.md index 3ea2109..fa61c56 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,6 +1,6 @@ # The Less Obvious Conference Checklist -This is a checklist of less obvious things for conference organisers that help build amazing, wonderful, welcoming and inclusive events. It’s easy to remember to book a venue, look for speakers and sell the tickets, but you could overlook many things that can help your conference stand out. I mainly compiled this list from my own experience and from what I’ve seen other conferences do. So although I compiled the list, many recommendations are the result of hard work of others. See the AUTHORS file for a more extensive attribution. +This is a checklist of less obvious things for conference organisers that help build amazing, wonderful, welcoming and inclusive events. It’s easy to remember to book a venue, look for speakers and sell the tickets, but you could overlook many things that can help your conference stand out. I mainly compiled this list from my own experience and from what I’ve seen other conferences do. So although I compiled the list, many recommendations are the result of hard work of others. See the [AUTHORS file](https://github.com/mxsasha/lessobviouschecklist/blob/main/AUTHORS.md) for a more extensive attribution. This is not a checklist of things you must do in order for your conference to be any good. Or a list of requirements for me to do something for your conference. Consider this more as a list of actionable and practical suggestions to help us make better conferences. You will probably not be able to follow every single suggestion, and that's fine.