-
Notifications
You must be signed in to change notification settings - Fork 0
🧭 Initial Compass #1
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
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| --- | ||
| title: OXA Team Compass | ||
| --- | ||
|
|
||
| The OXA Team Compass is the central resource for governance, planning, and community engagement for the Open Exchange Architecture (OXA) project. | ||
|
|
||
| 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. | ||
|
|
||
| ## Purpose | ||
|
|
||
| This compass serves as a guide for: | ||
|
|
||
| - **Steering Council** membership and governance for the OXA project | ||
| - **Decision-making processes** and policies | ||
| - **Planning documents** and roadmaps | ||
| - **Meeting agendas** and minutes | ||
| - **Community resources** and contribution guidelines | ||
|
|
||
| ## Steering Council | ||
|
|
||
| The OXA Steering Council is responsible for strategic direction, governance decisions, and ensuring the long-term health of the OXA project. | ||
|
|
||
| ### Current Members | ||
|
|
||
| - **Nokome Bentley** ([\@nokome](https://github.com/nokome)) — Steering Council Member | ||
| - **Rowan Cockett** ([\@rowanc1](https://github.com/rowanc1)) — Steering Council Member | ||
| - **Coming Soon** — Steering Council Member | ||
| - **Coming Soon** — Steering Council Member | ||
|
|
||
| ## Governance | ||
|
|
||
| ### Decision-Making | ||
|
|
||
| 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. | ||
|
|
||
| ### Membership | ||
|
|
||
| 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. | ||
|
|
||
| ### Term Length | ||
|
|
||
| Steering Council members serve for renewable terms, typically two years, with staggered terms to ensure continuity. | ||
|
|
||
| ## Planning, Practices & Contributing | ||
|
|
||
| - [OXA Roadmap & Planning](./planning.md) for a general roadmap of where we plan to take the project | ||
| - [Contributing Guide](./contributing.md) for repository guides and code organization | ||
| - [Practices](./practices.md) for development workflows and processes | ||
| - [Community Meetings](./meetings.md) for information on past and upcoming meetings | ||
|
|
||
| ## Resources | ||
|
|
||
| ### Documentation | ||
|
|
||
| - [OXA](https://oxa.dev) — The main OXA specification and documentation | ||
| - [OXA Repository](https://github.com/oxa-dev/oxa) — Source code and schema definitions | ||
| - [Contributing Guide](./contributing.md) has additional information and pointers | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| --- | ||
| title: Contributing to and improving OXA | ||
| short_title: Contributing | ||
| --- | ||
|
|
||
| OXA is an open community specification. We welcome contributions from tool builders, publishers, repositories, and researchers who want to advance interoperable, open science. | ||
|
|
||
| Ways to contribute: | ||
|
|
||
| - **Extend the schema** for your tools and use cases | ||
| - **Discuss interoperability** on GitHub issues | ||
| - **Submit examples** and validators | ||
| - **Propose enhancements** to the specification | ||
| - **Participate in meetings** and discussions | ||
|
|
||
| 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. | ||
|
|
||
| ## Communication Channels | ||
|
|
||
| - [GitHub Discussions](https://github.com/orgs/oxa-dev/discussions) for general discussion and Q&A | ||
| - [GitHub Issues](https://github.com/oxa-dev/oxa/issues): Bug reports and feature requests for OXA | ||
| - [Discord](https://discord.oxa.dev): Real-time community chat | ||
| - [Meetings](./meetings.md): Regular community calls | ||
|
|
||
| ## Outreach | ||
|
|
||
| We welcome you to help amplify the project through the following mechanisms: | ||
|
|
||
| - Conference presentations and workshops | ||
| - Blog posts and articles | ||
| - Tutorial videos and examples | ||
| - Integration showcases | ||
|
|
||
| Please reach out through [Discord](https://discord.oxa.dev) to ask if there are materials that you can build on. | ||
|
|
||
| (repositories)= | ||
|
|
||
| ## Repositories | ||
|
|
||
| The OXA project is organized across multiple repositories: | ||
|
|
||
| <https://github.com/oxa-dev/compass> | ||
| : Contains information to point to various resources in the ecosystem and is deployed to <https://oxa.dev> | ||
|
|
||
| <https://github.com/oxa-dev/rfc> | ||
| : Information about the request-for-comment process and accepted RFCs | ||
|
|
||
| <https://github.com/oxa-dev/oxa> | ||
| : Contains the schemas, types (Python, Rust, Typescript) and command-line tools for validation | ||
|
|
||
| <https://github.com/oxa-dev/workers> | ||
| : Cloudflare workers for the website, for public access to the published schemas | ||
|
|
||
| <https://github.com/oxa-dev/blog> | ||
| : Blog content, posted to <https://oxa.dev/blog> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| --- | ||
| title: Community Meetings | ||
| short_title: Meetings | ||
| --- | ||
|
|
||
| ### Meeting Schedule | ||
|
|
||
| Regular Steering Council meetings are held to discuss project direction, review proposals, and make governance decisions. Meeting details will be documented here. | ||
|
|
||
| :::{warning} We have no meetings scheduled | ||
| We aim to start these in Q1 2026 | ||
| ::: | ||
|
|
||
| ### Agendas and Minutes | ||
|
|
||
| Meeting agendas and minutes are archived in the meetings directory in the compass. | ||
|
|
||
| Join [Discord](https://discord.oxa.dev) to be updated. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| # Meeting Notes | ||
|
|
||
| This directory contains agendas and minutes from OXA Steering Council and community meetings. | ||
|
|
||
| ## Structure | ||
|
|
||
| Meeting notes are organized by year: | ||
|
|
||
| ``` | ||
| meetings/ | ||
| ├── 2025/ | ||
| │ └── 2025-01-XX.md | ||
| └── README.md | ||
| ``` | ||
|
|
||
| ## Meeting Notes Format | ||
|
|
||
| Each meeting note should follow this format: | ||
|
|
||
| ```markdown | ||
| # Meeting Title - YYYY-MM-DD | ||
|
|
||
| ## Attendees | ||
|
|
||
| - Name (Organization) | ||
| - Name (Organization) | ||
|
|
||
| ## Agenda | ||
|
|
||
| 1. Topic 1 | ||
| 2. Topic 2 | ||
| 3. ... | ||
|
|
||
| ## Discussion | ||
|
|
||
| ### Topic 1 | ||
|
|
||
| - Discussion points | ||
| - Decisions made | ||
|
|
||
| ### Topic 2 | ||
|
|
||
| - Discussion points | ||
| - Action items | ||
|
|
||
| ## Action Items | ||
|
|
||
| - [ ] Action item 1 - Assignee - Due date | ||
| - [ ] Action item 2 - Assignee - Due date | ||
| ``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| --- | ||
| title: Practices & Processes | ||
| --- | ||
|
|
||
| These are guidelines not rules; use your best judgment. | ||
| If you are unsure or want to talk something through, ask questions in [Discord](https://discord.oxa.dev). | ||
|
|
||
| ## Development Practices | ||
|
|
||
| ### Issue Tracking | ||
|
|
||
| - Use GitHub Issues for bug reports, feature requests; see [repository list](#repositories) | ||
| - Ask public questions in [GitHub Discussions](https://github.com/orgs/oxa-dev/discussions) | ||
|
|
||
| ### Branching Strategy | ||
|
|
||
| - `main` branch: Stable, release-ready code | ||
| - Use **squash merges** to keep the main branch simple | ||
|
|
||
| ### Code Reviews | ||
|
|
||
| - Changes should have pull request review | ||
| - At least one Steering Council member approval for significant changes | ||
| - Automated testing should pass before merge | ||
| - Merge optimistically, especially if you are building on the change | ||
| - If you need a review/merge and aren't getting attention, send a message in [Discord](https://discord.oxa.dev) | ||
|
|
||
| ## Decision-Making Process | ||
|
|
||
| ### Proposals | ||
|
|
||
| - Major changes require a proposal document, see the [RFC process](./rfc.md) for more information | ||
| - Proposals include motivation, detailed design, alternatives considered, migration path | ||
|
|
||
| ### Consensus Building | ||
|
|
||
| - Aim for consensus among active contributors | ||
| - If consensus cannot be reached, Steering Council makes final decision | ||
| - Decisions are documented and communicated clearly |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| --- | ||
| title: Request For Comment Process | ||
| --- | ||
|
|
||
| ### Proposals | ||
|
|
||
| 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. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@nokome can you read and approve this?