Skip to content

Commit

Permalink
feat: initial setup
Browse files Browse the repository at this point in the history
  • Loading branch information
acolombier committed Mar 24, 2024
1 parent 93fd427 commit f1b0f3c
Show file tree
Hide file tree
Showing 9 changed files with 474 additions and 2 deletions.
6 changes: 6 additions & 0 deletions .github/.mdox.validator.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
version: 1

# Don't check external URLs, currently it can timeout a lot on CI.
validators:
- type: ignore
regex: https://.*
33 changes: 33 additions & 0 deletions .github/workflows/proposals.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: proposals

on:
push:
branches:
- main
tags:
pull_request:

jobs:
lint:
runs-on: ubuntu-latest
name: Markdown formatting and link checking.
steps:
- name: Checkout code into the Go module directory.
uses: actions/checkout@v3

- name: Install Go
uses: actions/setup-go@v4
with:
go-version: 1.19.x

- uses: actions/cache@v3
with:
path: ~/go/pkg/mod
key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}

- name: Check
env:
GOBIN: /tmp/.bin
run: |
go install github.com/bwplotka/mdox@latest
make check
17 changes: 17 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
.idea

# Binaries for programs and plugins
*.exe
*.exe~
*.dll
*.so
*.dylib

# Test binary, built with `go test -c`
*.test

# Output of the go coverage tool, specifically when used with LiteIDE
*.out

# Dependency directories (remove the comment below to include it)
# vendor/
73 changes: 73 additions & 0 deletions 0000-00-00_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
# Template

Feel free to copy this file and feel all the details below.

See [README](README.md) for details.

## Your Proposal Title

* **Owners:**
* `<@author: single champion for the moment of writing. No need to add contributors all will be visible in commit or comments history on GitHub.>`

* **Implementation Status:** `Not implemented / Partially implemented / Implemented`

* **Related Issues and PRs:**
* `<GH Issues/PRs>`

* **Other docs or links:**
* `<Links…>`

> TL;DR: Give here a short summary of what this document is proposing and what components it is touching. Outline rough idea of proposer's view on proposed changes.
>
> *For example: This design doc is proposing a consistent design template for “example.com” organization.*
## Why

Put here a motivation behind the change proposed by this design document, give context.

*For example: It’s important to clearly explain the reasons behind certain design decisions in order to have a consensus between team members, as well as external stakeholders. Such a design document can also be used as a reference and knowledge-sharing purposes. That’s why we are proposing a consistent style of the design document that will be used for future designs.*

### Pitfalls of the current solution

What specific problems are we hitting with the current solution? Why it’s not enough?

*For example, We were missing a consistent design doc template, so each team/person was creating their own. Because of inconsistencies, those documents were harder to understand, and it was easy to miss important sections. This was causing certain engineering time to be wasted.*

## Goals

Goals and use cases for the solution as proposed in [How](#how):

* Allow easy collaboration and decision making on design ideas.
* Have a consistent design style that is readable and understandable.
* Have a design style that is concise and covers all the essential information.

### Audience

If not clear, the target audience that this change relates to.

## Non-Goals

* Move old designs to the new format.
* Not doing X,Y,Z.

## How

Explain the full overview of the proposed solution. Some guidelines:

* Make it concise and **simple**; put diagrams; be concrete, avoid using “really”, “amazing” and “great” (:
* How you will test and verify?
* How you will migrate users, without downtime. How we solve incompatibilities?
* What open questions are left? (“Known unknowns”)

## Alternatives

The section stating potential alternatives. Highlight the objections reader should have towards your proposal as they read it. Tell them why you still think you should take this path [[ref](https://twitter.com/whereistanya/status/1353853753439490049)]

1. This is why not solution Z...

## Action Plan

The tasks to do in order to migrate to the new idea.

* [ ] Task one <GH issue>
* [ ] Task two <GH issue> ...
86 changes: 86 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
# Mixxx Code of Conduct

The Mixxx team is committed to preserving and fostering a
diverse, welcoming community. Below is our community code of conduct, which
applies to our repos and organizations, mailing lists, forums, IRC channels,
blog content, and any
other Mixxx-supported communication group, as well as any private
communication initiated in the context of these spaces.

Simply put, community discussions should be

* respectful and kind;
* about Mixxx;
* about features and code, not the individuals involved.

## Be respectful and constructive

Treat everyone with respect. Build on each other's ideas. Each of us has the
right to enjoy our experience and participate without fear of harassment,
discrimination, or condescension, whether blatant or subtle. Remember that
Mixxx is a geographically distributed team and that you may not be
communicating with someone in their primary language. We all get frustrated
when working on hard problems, but we cannot allow that frustration to turn
into personal attacks.

## Speak up if you see or hear something

You are empowered to politely engage when you feel that you or others are
disrespected. The person making you feel uncomfortable may not be aware of what
they are doing - politely bringing their behavior to their attention is
encouraged.

If you are uncomfortable speaking up, or feel that your concerns are not being
duly considered, you can email [email protected] to request involvement
from a community manager. You may also email any of the community managers
directly. All concerns shared with community managers will be kept
confidential. In cases where a public response is deemed necessary, the
identities of victims and reporters will remain confidential unless those
individuals instruct us otherwise.

While all reports will be taken seriously, the Mixxx community managers may
not act on complaints that they feel are not violations of this code of
conduct.

## No Tolerance for Harassment

We will not tolerate harassment of any kind, including but not limited to:

* Harassing comments
* Intimidation
* Encouraging a person to engage in self-harm.
* Sustained disruption or derailing of threads, channels, lists, etc.
* Offensive or violent comments, jokes or otherwise
* Inappropriate sexual content
* Unwelcome sexual or otherwise aggressive attention
* Continued one-on-one communication after requests to cease
* Distribution or threat of distribution of people's personally identifying
information, AKA “doxing”

## Consequences for failing to comply with this policy

Consequences for failing to comply with this policy may include, at the sole
discretion of the Mixxx community managers:

* a request for an apology;
* a private or public warning or reprimand;
* a temporary ban from the mailing list, blog, Mixxx repository or
organization, or other Mixxx-supported communication group, including
loss of committer status;
* a permanent ban from any of the above, or from all current and future
Mixxx-supported communities, including loss of
committer status.

Participants warned to stop any harassing behavior are expected to comply
immediately; failure to do so will result in an escalation of consequences.

## Acknowledgements

This Code of Conduct is based on the Chromium Code of Conduct, which credits
the Geek Feminism Code of Conduct, the Django Code of Conduct and the Geek
Feminism Wiki "Effective codes of conduct" guide.

## License

This Code of Conduct is available for reuse under the Creative Commons Zero
(CC0) license.
Loading

0 comments on commit f1b0f3c

Please sign in to comment.