Add Developer Guides, replace internal.md, CONTRIBUTING.md #625
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
…into docs/libdesign
trxcllnt
approved these changes
Aug 16, 2022
|
@isVoid did you want help adding to this doc? |
|
That would be awesome. Let's chat about this soon. |
…into docs/libdesign
harrism
added
doc
…into docs/devguide
Closed
isVoid
changed the title
harrism
requested changes
Aug 25, 2022
Co-authored-by: Mark Harris <[email protected]>
Co-authored-by: Mark Harris <[email protected]>
Co-authored-by: Mark Harris <[email protected]>
Co-authored-by: Mark Harris <[email protected]>
isVoid
commented
Aug 26, 2022
Comment on lines
+125
to
+126
| Therefore the wrapper should not contain additional components besides | ||
| the above. |
There was a problem hiding this comment.
Suggested change
| Therefore the wrapper should not contain additional components besides | |
| the above. | |
| Therefore, the wrapper should avoid further data processing and be as | |
| simple as possible. |
thomcom
approved these changes
Aug 29, 2022
There was a problem hiding this comment.
The only change I saw worth noting is that you appear to go back and forth
in your line length selection. For the user docs I am setting all of the lines to
(provisionally) 96 chars wide, and using the double space as a CRLF
delimiter to instruct markdown to always start a new line where I suggest.
It's my opinion that this improves readability by giving a limited column width
in HTML, and giving a consistent column width when reading in .md.
harrism
approved these changes
Sep 7, 2022
|
rerun tests |
|
@gpucibot merge |
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.
This PR introduces 3 documents for developer guides. The overall goal for these docs is to provide a place to centralize best practices and provide guidance to developers of all levels to bootstrap development for cuspatial.
This PR deprecates internals.md. The design of geocolumn has improved dramatically since #585 , rendering many of the description obsolete. Further, examples of geoarrow and detail description of geoarrow should be hosted in geoarrow specification.
library_design.mdreplacesinternal.md.CONTRIBUTING.mdis deprecated and only leaves a pointer tocontributing_guide.md. The contents are highly identical to the overall RAPIDS contribution guide: https://docs.rapids.ai/contributing. This link is included in the contributing guide and is thus removed to maintain a single source of truth.