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

Additional things to mention in the README #8

Open
2 of 3 tasks
baltpeter opened this issue Apr 9, 2023 · 1 comment
Open
2 of 3 tasks

Additional things to mention in the README #8

baltpeter opened this issue Apr 9, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@baltpeter
Copy link
Member

baltpeter commented Apr 9, 2023

With #7, I've added a basic README. Here's a few things that I think we should also go into but didn't yet due to time constraints:

  • Explain the adapter format and how to contribute an adapter.
  • Mention tracker-wiki once that's ready.
  • Explain the flow of how requests are parsed (decode -> data paths).
@baltpeter
Copy link
Member Author

With #13, we're mostly there but:

I am especially wondering if you think this README still need another explanation of how the data extraction works in its own section (and not "Contributing adapters").

Well, I would expect that a significantly larger portion of people reading the README will be interested in a general idea of how TrackHAR works compared to people who actually want to contribute. So, I'd say yes. But that doesn't really have to happen now, we probably have more important things to do (and the information is pretty much all there already…). If we do add this at some point, we should probably split the contributing section into a separate CONTRIBUTING.md to not overwhelm people.

@baltpeter baltpeter added good first issue Good for newcomers help wanted Extra attention is needed labels Jun 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant