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.

Sign up for GitHub

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

Jump to bottom

Missing developer docs #6631

Open
shelvacu opened this issue Dec 9, 2024 · 1 comment
Open

Missing developer docs #6631

shelvacu opened this issue Dec 9, 2024 · 1 comment

Comments

@shelvacu
Copy link

shelvacu commented Dec 9, 2024

I think some docs would be very nice for anyone who wishes to contribute. In no particular order:

  • At the most basic, how to build & run. What's the Dockerfile? Is that useful? Required?
  • What do you want for code style? Is there some bad code style in the codebase that you want to avoid in new PRs, or is copying the existing style generally a good idea?
  • An outline for how to implement a new site support, or a new extractor for an already implemented site.
  • An overview of the available utilities/lib that are often useful.
  • How do I run tests? (partial answer: make test, but that doesn't run the network tests, and I don't know how to run a particular test)
  • If you're willing, how to get in contact with you (outside of github issues)
@SpiffyChatterbox
Copy link

Many of these are open for discussion! I'm very interested in this topic, and happy to collaborate.

We have some discussions about the extractor (new site) over here .

And some of the more seasoned folks answered some of my testing questions here.

I put some of the utilities in my draft wiki pages over here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@shelvacu @SpiffyChatterbox