Add a README for developers #752
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
We should have a README for people who want to contribute to BSC, but need help getting started. We should also have more documentation on the internals of the BSC source code. This is an attempt to start both. This PR creates a
DEVELOP.mdfile that should aim to serve as a README on how to develop and contribute, and is linked from the mainREADME.mdvia a new heading "Develop". This file can eventually point to more detailed documentation, but that doesn't exist yet. However, there have been detailed write-ups on individual topics, in response to questions here on GitHub and on the mailing lists, that could eventually be collected into a document. This file provides an index of links to those write-ups -- which should hopefully be useful to developers (and potential developers) in the meantime, and can also be a place to record the links for eventual conversion into a document. Please feel free to submit PRs to add more links to the index (if you see something missing) or to otherwise improve the file. Thanks!