Issue 533: Update developer documentation #541
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
dogle-scottlogic
added
the
community structure
There was a problem hiding this comment.
Honestly, I think this should be at the root of the entire project called CONTRIBUTING.md. It would be easier for folks to find it. Thoughts on this @dogle-scottlogic?
|
@damienjburks - we could do, the other option is to link to this doc from the root README.md so there's just a single doc at the root level to get started with the project but happy either way? |
|
@dogle-scottlogic I think the better approach would be to move it out to the root as CONTRIBUTING.md. Let's do that. |
damienjburks
previously approved these changes
Nov 18, 2024
sshiells-scottlogic
previously approved these changes
Nov 18, 2024
dogle-scottlogic
dismissed stale reviews from sshiells-scottlogic and damienjburks
via
80b3253
dogle-scottlogic
force-pushed
the
CCC-533-developer-guide
branch
from
80b3253 to
96cc3b0
Compare
dogle-scottlogic
force-pushed
the
CCC-533-developer-guide
branch
3 times, most recently
from
b749f97 to
998fc81
Compare
damienjburks
previously approved these changes
Nov 19, 2024
dogle-scottlogic
force-pushed
the
CCC-533-developer-guide
branch
from
7af4dd8 to
d47ba74
Compare
dogle-scottlogic
force-pushed
the
CCC-533-developer-guide
branch
from
d47ba74 to
f920dcf
Compare
There was a problem hiding this comment.
Note that this change will also need to remove .github/CONTRIBUTING.md, which is linked under the description when folks create a PR
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.
Update the developer document to be a more complete contributors guide.
Resolves issue #533