Skip to content

Commit 7db3270

Browse files
committed
feat: initial setup
1 parent 93fd427 commit 7db3270

9 files changed

Lines changed: 478 additions & 2 deletions

File tree

.github/.mdox.validator.yaml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
version: 1
2+
3+
# Don't check external URLs, currently it can timeout a lot on CI.
4+
validators:
5+
- type: ignore
6+
regex: https://.*

.github/workflows/proposals.yaml

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
name: proposals
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
tags:
8+
pull_request:
9+
10+
jobs:
11+
lint:
12+
runs-on: ubuntu-latest
13+
name: Markdown formatting and link checking.
14+
steps:
15+
- name: Checkout code into the Go module directory.
16+
uses: actions/checkout@v3
17+
18+
- name: Install Go
19+
uses: actions/setup-go@v4
20+
with:
21+
go-version: 1.19.x
22+
23+
- uses: actions/cache@v3
24+
with:
25+
path: ~/go/pkg/mod
26+
key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
27+
28+
- name: Check
29+
env:
30+
GOBIN: /tmp/.bin
31+
run: |
32+
go install github.com/bwplotka/mdox@latest
33+
make check

.gitignore

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
.idea
2+
3+
# Binaries for programs and plugins
4+
*.exe
5+
*.exe~
6+
*.dll
7+
*.so
8+
*.dylib
9+
10+
# Test binary, built with `go test -c`
11+
*.test
12+
13+
# Output of the go coverage tool, specifically when used with LiteIDE
14+
*.out
15+
16+
# Dependency directories (remove the comment below to include it)
17+
# vendor/

0000-00-00_template.md

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
# Template
2+
3+
Feel free to copy this file and feel all the details below.
4+
5+
See [README](README.md) for details.
6+
7+
## Your Proposal Title
8+
9+
* **Owners:**
10+
* `<@author: single champion for the moment of writing. No need to add contributors all will be visible in commit or comments history on GitHub.>`
11+
12+
* **Implementation Status:** `Not implemented / Partially implemented / Implemented`
13+
14+
* **Related Issues and PRs:**
15+
* `<GH Issues/PRs>`
16+
17+
* **Other docs or links:**
18+
* `<Links…>`
19+
20+
> 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.
21+
>
22+
> *For example: This design doc is proposing a consistent design template for “example.com” organization.*
23+
24+
## Why
25+
26+
Put here a motivation behind the change proposed by this design document, give context.
27+
28+
*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.*
29+
30+
### Pitfalls of the current solution
31+
32+
What specific problems are we hitting with the current solution? Why it’s not enough?
33+
34+
*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.*
35+
36+
## Goals
37+
38+
Goals and use cases for the solution as proposed in [How](#how):
39+
40+
* Allow easy collaboration and decision making on design ideas.
41+
* Have a consistent design style that is readable and understandable.
42+
* Have a design style that is concise and covers all the essential information.
43+
44+
### Audience
45+
46+
If not clear, the target audience that this change relates to.
47+
48+
## Non-Goals
49+
50+
* Move old designs to the new format.
51+
* Not doing X,Y,Z.
52+
53+
## How
54+
55+
Explain the full overview of the proposed solution. Some guidelines:
56+
57+
* Make it concise and **simple**; put diagrams; be concrete, avoid using “really”, “amazing” and “great” (:
58+
* How you will test and verify?
59+
* How you will migrate users, without downtime. How we solve incompatibilities?
60+
* What open questions are left? (“Known unknowns”)
61+
62+
## Alternatives
63+
64+
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)]
65+
66+
1. This is why not solution Z...
67+
68+
## Action Plan
69+
70+
The tasks to do in order to migrate to the new idea.
71+
72+
* [ ] Task one <GH issue>
73+
* [ ] Task two <GH issue> ...

CODE_OF_CONDUCT.md

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
# Mixxx Code of Conduct
2+
3+
The Mixxx team is committed to preserving and fostering a
4+
diverse, welcoming community. Below is our community code of conduct, which
5+
applies to our repos and organizations, mailing lists, forums, IRC channels,
6+
blog content, and any
7+
other Mixxx-supported communication group, as well as any private
8+
communication initiated in the context of these spaces.
9+
10+
Simply put, community discussions should be
11+
12+
* respectful and kind;
13+
* about Mixxx;
14+
* about features and code, not the individuals involved.
15+
16+
## Be respectful and constructive
17+
18+
Treat everyone with respect. Build on each other's ideas. Each of us has the
19+
right to enjoy our experience and participate without fear of harassment,
20+
discrimination, or condescension, whether blatant or subtle. Remember that
21+
Mixxx is a geographically distributed team and that you may not be
22+
communicating with someone in their primary language. We all get frustrated
23+
when working on hard problems, but we cannot allow that frustration to turn
24+
into personal attacks.
25+
26+
## Speak up if you see or hear something
27+
28+
You are empowered to politely engage when you feel that you or others are
29+
disrespected. The person making you feel uncomfortable may not be aware of what
30+
they are doing - politely bringing their behavior to their attention is
31+
encouraged.
32+
33+
If you are uncomfortable speaking up, or feel that your concerns are not being
34+
duly considered, you can email community@mixxx.org to request involvement
35+
from a community manager. You may also email any of the community managers
36+
directly. All concerns shared with community managers will be kept
37+
confidential. In cases where a public response is deemed necessary, the
38+
identities of victims and reporters will remain confidential unless those
39+
individuals instruct us otherwise.
40+
41+
While all reports will be taken seriously, the Mixxx community managers may
42+
not act on complaints that they feel are not violations of this code of
43+
conduct.
44+
45+
## No Tolerance for Harassment
46+
47+
We will not tolerate harassment of any kind, including but not limited to:
48+
49+
* Harassing comments
50+
* Intimidation
51+
* Encouraging a person to engage in self-harm.
52+
* Sustained disruption or derailing of threads, channels, lists, etc.
53+
* Offensive or violent comments, jokes or otherwise
54+
* Inappropriate sexual content
55+
* Unwelcome sexual or otherwise aggressive attention
56+
* Continued one-on-one communication after requests to cease
57+
* Distribution or threat of distribution of people's personally identifying
58+
information, AKA “doxing”
59+
60+
## Consequences for failing to comply with this policy
61+
62+
Consequences for failing to comply with this policy may include, at the sole
63+
discretion of the Mixxx community managers:
64+
65+
* a request for an apology;
66+
* a private or public warning or reprimand;
67+
* a temporary ban from the mailing list, blog, Mixxx repository or
68+
organization, or other Mixxx-supported communication group, including
69+
loss of committer status;
70+
* a permanent ban from any of the above, or from all current and future
71+
Mixxx-supported communities, including loss of
72+
committer status.
73+
74+
Participants warned to stop any harassing behavior are expected to comply
75+
immediately; failure to do so will result in an escalation of consequences.
76+
77+
## Acknowledgements
78+
79+
This Code of Conduct is based on the Chromium Code of Conduct, which credits
80+
the Geek Feminism Code of Conduct, the Django Code of Conduct and the Geek
81+
Feminism Wiki "Effective codes of conduct" guide.
82+
83+
## License
84+
85+
This Code of Conduct is available for reuse under the Creative Commons Zero
86+
(CC0) license.

0 commit comments

Comments
 (0)