Skip to content
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

Link the relevant specs/docs from the README #501

Open
4 tasks
oliverklee opened this issue Feb 24, 2024 · 2 comments
Open
4 tasks

Link the relevant specs/docs from the README #501

oliverklee opened this issue Feb 24, 2024 · 2 comments

Comments

@oliverklee
Copy link
Contributor

oliverklee commented Feb 24, 2024

User stories

As a developer of this library, I want the relevant specs I need to know for developing this library linked from the README for easy access.

As a user of this library, , I want the relevant specs linked from the README for easy access so I can look up the terms this library uses and the expected data structures.

Acceptance criteria

  • There is a section on specs and RFCs in the README.
  • The relevant specs are listed with a short explanation what they define and what use they are for developers and users of this library.
  • When there are multiple sources for some RFC, favor the authoritative source over the secondary source, and favor easy-to-read sources (which might be conflicting requirements).
  • The README is auto-formatted according to the .editorconfig.

Helpful links

This is a starting point. Not all of these URLs need necessarily end up in the README, and there might be other URLs that are not listed here and that are helpful to add to the README as well.

Additional information

This task requires understanding which RFCs are relevant to this project, and looking through the suggested sources and looking for additional sources.

@oliverklee oliverklee changed the title Link the relevant specs from the README Link the relevant specs/docs from the README Feb 24, 2024
@calvinrodrigues500
Copy link

@oliverklee Can you give a bit more detail about the issue and assign it to me, I would like to contirbute.

@oliverklee
Copy link
Contributor Author

Welcome to the project, @calvinrodrigues500! 👋

I've updated the issue description to (hopefully) be more helpful.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants