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

Best practices document #62

Open
the8472 opened this issue May 9, 2017 · 3 comments
Open

Best practices document #62

the8472 opened this issue May 9, 2017 · 3 comments

Comments

@the8472
Copy link
Contributor

the8472 commented May 9, 2017

Would it make sense to have an informal document, probably not even a BEP, documenting best implmentation practices so that people don't have to rediscover the wheel? Even linking to blog posts, issue trackers and implementations may be appropriate for some points.

The discussion about sanitizing path names in for BTv2 or this unicode LTR confusion thing.

Many questions on stack overflow or IRC also arise from the specs leaving a lot of things up to the implementations.

@ssiloti
Copy link
Contributor

ssiloti commented May 11, 2017

I agree it would be nice to collect all of the arcane knowledge about implementing bittorrent into a coherent document. At the moment I can't say I would commit much time to such an effort though. PRs would be welcome of course.

@the8472
Copy link
Contributor Author

the8472 commented May 11, 2017

I think for a start a list of links and bullet points in a markdown document and a "just accept PRs" strategy would be good enough. bt.org is hosted as github pages and renders MD automatically, right?

@ssiloti
Copy link
Contributor

ssiloti commented May 11, 2017

Rendering HTML from reStructuredText is a manual process but I can take care of that. Otherwise everything updates automatically from the github repo.

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

No branches or pull requests

2 participants