Rewrite the contributing guide #1514
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
nickcharlton
added
the
documentation
nickcharlton
force-pushed
the
nc-contributing-guide
branch
from
76152af to
532f1ae
Compare
nickcharlton
force-pushed
the
nc-contributing-guide
branch
from
532f1ae to
4ba8583
Compare
Closed
The goal behind this document should be to explain to new and potential contributors what they need to do (and follow) to get involved and it wasn't really doing that. It should also be a document that we can link to when closing or explaining reasoning behind decisions. Broadly, it should aim to ensure decisions aren't just arbitary. * Link to the contributing guide in the docs, * Move repository/architecture discussion to the Contributing Guide, * Document the use of labels (this matches those setup in GitHub), * Document how releases happen and how it fits the hosted applications.
nickcharlton
force-pushed
the
nc-contributing-guide
branch
from
a46b533 to
3e8833e
Compare
mike-burns
reviewed
Jan 2, 2020
Co-Authored-By: Mike Burns <mike@mike-burns.com>
Co-Authored-By: Mike Burns <mike@mike-burns.com>
nickcharlton
pushed a commit
that referenced
this pull request
Jul 31, 2020
In #1514, we added a symlink so that the docs would show up on the demo app …but symlinks aren't supported on Windows and was causing a problem when trying to bundle. This instead adds a lookup table of files not in docs/ which allows us to render those. This partially fixes #1693, in allowing Administrate itself to be bundled without a symlink but other dependencies have the same problem.
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.
The goal behind this document should be to explain to new and potential
contributors what they need to do (and follow) to get involved and it
wasn't really doing that.
It should also be a document that we can link to when closing or explaining
reasoning behind decisions. Broadly, it should aim to ensure decisions
aren't just arbitrary.