Skip to content

Commit 40a0391

Browse files
rowanc1rowanc1
authored
🧭 Initial Compass (#1)
1 parent e75e5db commit 40a0391

8 files changed

Lines changed: 243 additions & 1 deletion

File tree

‎compass.md‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
---
2+
title: OXA Team Compass
3+
---
4+
5+
The OXA Team Compass is the central resource for governance, planning, and community engagement for the Open Exchange Architecture (OXA) project.
6+
7+
The OXA project is stewarded by the [Continuous Science Foundation](https://continuousfoundation.org), a grassroots, community-driven organization that brings together researchers, tool builders, publishers, and standards groups to support modular, continuous ways of publishing research.
8+
9+
## Purpose
10+
11+
This compass serves as a guide for:
12+
13+
- **Steering Council** membership and governance for the OXA project
14+
- **Decision-making processes** and policies
15+
- **Planning documents** and roadmaps
16+
- **Meeting agendas** and minutes
17+
- **Community resources** and contribution guidelines
18+
19+
## Steering Council
20+
21+
The OXA Steering Council is responsible for strategic direction, governance decisions, and ensuring the long-term health of the OXA project.
22+
23+
### Current Members
24+
25+
- **Nokome Bentley** ([\@nokome](https://github.com/nokome)) — Steering Council Member
26+
- **Rowan Cockett** ([\@rowanc1](https://github.com/rowanc1)) — Steering Council Member
27+
- **Coming Soon** — Steering Council Member
28+
- **Coming Soon** — Steering Council Member
29+
30+
## Governance
31+
32+
### Decision-Making
33+
34+
Changes and improvements to OXA are completed through a community [Request For Comment](./rfc.md) process. The Steering Council tries to make all decisions through consensus. When consensus cannot be reached, decisions are made by majority vote of the Steering Council.
35+
36+
### Membership
37+
38+
Steering Council members are selected based on their commitment to the OXA project, technical expertise, and ability to represent diverse perspectives in the scientific publishing ecosystem. New members are added through a nomination and voting process by existing Steering Council members.
39+
40+
### Term Length
41+
42+
Steering Council members serve for renewable terms, typically two years, with staggered terms to ensure continuity.
43+
44+
## Planning, Practices & Contributing
45+
46+
- [OXA Roadmap & Planning](./planning.md) for a general roadmap of where we plan to take the project
47+
- [Contributing Guide](./contributing.md) for repository guides and code organization
48+
- [Practices](./practices.md) for development workflows and processes
49+
- [Community Meetings](./meetings.md) for information on past and upcoming meetings
50+
51+
## Resources
52+
53+
### Documentation
54+
55+
- [OXA](https://oxa.dev) — The main OXA specification and documentation
56+
- [OXA Repository](https://github.com/oxa-dev/oxa) — Source code and schema definitions
57+
- [Contributing Guide](./contributing.md) has additional information and pointers

‎contributing.md‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
title: Contributing to and improving OXA
3+
short_title: Contributing
4+
---
5+
6+
OXA is an open community specification. We welcome contributions from tool builders, publishers, repositories, and researchers who want to advance interoperable, open science.
7+
8+
Ways to contribute:
9+
10+
- **Extend the schema** for your tools and use cases
11+
- **Discuss interoperability** on GitHub issues
12+
- **Submit examples** and validators
13+
- **Propose enhancements** to the specification
14+
- **Participate in meetings** and discussions
15+
16+
See the main OXA repository's [Contributing Guide](https://github.com/oxa-dev/oxa/blob/main/CONTRIBUTING.md) for more details on how to get involved.
17+
18+
## Communication Channels
19+
20+
- [GitHub Discussions](https://github.com/orgs/oxa-dev/discussions) for general discussion and Q&A
21+
- [GitHub Issues](https://github.com/oxa-dev/oxa/issues): Bug reports and feature requests for OXA
22+
- [Discord](https://discord.oxa.dev): Real-time community chat
23+
- [Meetings](./meetings.md): Regular community calls
24+
25+
## Outreach
26+
27+
We welcome you to help amplify the project through the following mechanisms:
28+
29+
- Conference presentations and workshops
30+
- Blog posts and articles
31+
- Tutorial videos and examples
32+
- Integration showcases
33+
34+
Please reach out through [Discord](https://discord.oxa.dev) to ask if there are materials that you can build on.
35+
36+
(repositories)=
37+
38+
## Repositories
39+
40+
The OXA project is organized across multiple repositories:
41+
42+
<https://github.com/oxa-dev/compass>
43+
: Contains information to point to various resources in the ecosystem and is deployed to <https://oxa.dev>
44+
45+
<https://github.com/oxa-dev/rfc>
46+
: Information about the request-for-comment process and accepted RFCs
47+
48+
<https://github.com/oxa-dev/oxa>
49+
: Contains the schemas, types (Python, Rust, Typescript) and command-line tools for validation
50+
51+
<https://github.com/oxa-dev/workers>
52+
: Cloudflare workers for the website, for public access to the published schemas
53+
54+
<https://github.com/oxa-dev/blog>
55+
: Blog content, posted to <https://oxa.dev/blog>

‎index.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,4 +55,6 @@ We welcome contributions from tool builders, publishers, and researchers who wan
5555

5656
> **Join us in building the foundation of a more connected scientific ecosystem.**
5757
58-
- [Slack](https://slack.continuousfoundation.org)
58+
For discussion, updates, and to connect with the OXA community, join our [Discord server](https://discord.oxa.dev).
59+
60+
Find more ways to contribute and get involved in the [Contributing Guide](./contributing.md).

‎meetings.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
title: Community Meetings
3+
short_title: Meetings
4+
---
5+
6+
### Meeting Schedule
7+
8+
Regular Steering Council meetings are held to discuss project direction, review proposals, and make governance decisions. Meeting details will be documented here.
9+
10+
:::{warning} We have no meetings scheduled
11+
We aim to start these in Q1 2026
12+
:::
13+
14+
### Agendas and Minutes
15+
16+
Meeting agendas and minutes are archived in the meetings directory in the compass.
17+
18+
Join [Discord](https://discord.oxa.dev) to be updated.

‎meetings/README.md‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Meeting Notes
2+
3+
This directory contains agendas and minutes from OXA Steering Council and community meetings.
4+
5+
## Structure
6+
7+
Meeting notes are organized by year:
8+
9+
```
10+
meetings/
11+
├── 2025/
12+
│ └── 2025-01-XX.md
13+
└── README.md
14+
```
15+
16+
## Meeting Notes Format
17+
18+
Each meeting note should follow this format:
19+
20+
```markdown
21+
# Meeting Title - YYYY-MM-DD
22+
23+
## Attendees
24+
25+
- Name (Organization)
26+
- Name (Organization)
27+
28+
## Agenda
29+
30+
1. Topic 1
31+
2. Topic 2
32+
3. ...
33+
34+
## Discussion
35+
36+
### Topic 1
37+
38+
- Discussion points
39+
- Decisions made
40+
41+
### Topic 2
42+
43+
- Discussion points
44+
- Action items
45+
46+
## Action Items
47+
48+
- [ ] Action item 1 - Assignee - Due date
49+
- [ ] Action item 2 - Assignee - Due date
50+
```

‎myst.yml‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,26 @@ project:
44
id: 872d9342-8932-4bb2-a1e0-91b3861cef85
55
title: Open Exchange Architecture
66
banner: ./banner.png
7+
github: https://github.com/oxa-dev/compass
78
abbreviations:
89
OXA: Open Exchange Architecture
910
AST: Abstract Syntax Tree
1011
JATS: Journal Article Tag Suite
1112
CC: Creative Commons
1213
JSON: JavaScript Object Notation
14+
RFC: Request For Comment
15+
toc:
16+
- file: index.md
17+
- title: Governance
18+
children:
19+
- file: compass.md
20+
- file: contributing.md
21+
- file: practices.md
22+
- file: rfc.md
23+
- title: Meetings
24+
children:
25+
- file: meetings.md
26+
- file: meetings/README.md
1327
site:
1428
template: book-theme
1529
# options:

‎practices.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
title: Practices & Processes
3+
---
4+
5+
These are guidelines not rules; use your best judgment.
6+
If you are unsure or want to talk something through, ask questions in [Discord](https://discord.oxa.dev).
7+
8+
## Development Practices
9+
10+
### Issue Tracking
11+
12+
- Use GitHub Issues for bug reports, feature requests; see [repository list](#repositories)
13+
- Ask public questions in [GitHub Discussions](https://github.com/orgs/oxa-dev/discussions)
14+
15+
### Branching Strategy
16+
17+
- `main` branch: Stable, release-ready code
18+
- Use **squash merges** to keep the main branch simple
19+
20+
### Code Reviews
21+
22+
- Changes should have pull request review
23+
- At least one Steering Council member approval for significant changes
24+
- Automated testing should pass before merge
25+
- Merge optimistically, especially if you are building on the change
26+
- If you need a review/merge and aren't getting attention, send a message in [Discord](https://discord.oxa.dev)
27+
28+
## Decision-Making Process
29+
30+
### Proposals
31+
32+
- Major changes require a proposal document, see the [RFC process](./rfc.md) for more information
33+
- Proposals include motivation, detailed design, alternatives considered, migration path
34+
35+
### Consensus Building
36+
37+
- Aim for consensus among active contributors
38+
- If consensus cannot be reached, Steering Council makes final decision
39+
- Decisions are documented and communicated clearly

‎rfc.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: Request For Comment Process
3+
---
4+
5+
### Proposals
6+
7+
Proposals are discussed in the [RFC](https://github.com/oxa-dev/rfc) repository and in the [Discord](https://discord.oxa.dev) `#rfc` channel. See the [RFC](https://github.com/oxa-dev/rfc) repository for more detailed discussions.

0 commit comments

Comments
 (0)