Skip to content

Commit

Permalink
Approve #1 - API Specification
Browse files Browse the repository at this point in the history
This RFC is now approved as-is. Further commentary is welcome and encouraged and will be incorporated, along with experimental feedback, into future updates to the API specification in later RFCs.
  • Loading branch information
ships committed Dec 6, 2023
2 parents 8f63b71 + ad925bc commit 7a8c94b
Show file tree
Hide file tree
Showing 3 changed files with 629 additions and 2 deletions.
18 changes: 18 additions & 0 deletions .github/pull_request_template.md
@@ -0,0 +1,18 @@
# Status

### WORK IN PROGRESS | READY FOR REVIEW <-- choose

### [Link to rendered proposal](https://github.com/Docmaps-Project/rfcs/blob/ships/1/APIProtocol/proposals/001_interop.md) <-- change link

---

# [ Title ]

### Checklist

- [ ] I have followed the [DocMaps Project code of conduct](https://github.com/Docmaps-Project/docmaps/blob/main/CODE_OF_CONDUCT.md).
- [ ] I have filled out relevant sections of the proposal document and included a link to its rendered form in this PR.

### Additional Information

Most relevant info should be in the proposal doc. Provide any additional information that might be helpful in understanding this pull request, such as screenshots, links to relevant other github convos, etc.
62 changes: 60 additions & 2 deletions README.md
@@ -1,2 +1,60 @@
# rfcs
Requests for Comment - proposals to changes to the Docmaps format and related protocols
# Docmaps RFC Process

This repository is for discussing and proposing changes to the Docmaps project.

## What is an RFC?

RFC stands for "Request For Comments." It is a proposal document that outlines a new feature, change or improvement to the Docmaps project. RFCs are used to start a discussion about a proposed change and to get feedback from the community before any code is written.

## How to submit an RFC

1. Fork this repository to your account.
2. Create a new branch for your proposal.
3. Create a new file in the `proposals` directory with the name of your proposal.
4. Copy and paste the RFC template into the new file.
5. Fill out the template with your proposal details.
6. Submit a pull request to the `main` branch of this repository.
7. The pull request template includes a place to copy a link to the `tree` Github-rendered markdown where your proposal can be found. Make sure to include this. It's easier than reading git diffs!

## RFC Template

```
# RFC Title
## Abstract
[Concise summary of the issue and resolution]
## Problem
[Describe the problem you are trying to solve]
## Proposed Solution
[Describe your proposed solution to the problem]
## Alternatives Considered
[Describe any alternative solutions you considered]
## Security and Privacy Considerations
[Describe any alternative solutions you considered]
## Implementation Notes
[Describe how you plan to implement your proposed solution]
## References and links
[Any relevant documentation, external links, and See Alsos]
```

## What happens after I submit an RFC?

After you submit an RFC, it will be reviewed by the Docmaps team. They will provide feedback and ask questions about your proposal as Pull request Commentary. The community is also encouraged to participate in the discussion.

If your proposal is accepted, the PR is merged and the proposal will live long-term in this repo.
You will then probably need to work with the Docmaps team to implement the changes.
If your proposal is not accepted, you are encouraged to revise your proposal and resubmit it.

0 comments on commit 7a8c94b

Please sign in to comment.