thisisnic commented on a change in pull request #11705: URL: https://github.com/apache/arrow/pull/11705#discussion_r751990716
########## File path: r/vignettes/developing.Rmd ########## @@ -38,567 +38,31 @@ set -e set -x ``` -If you're looking to contribute to arrow, this vignette can help you set up a development environment that will enable you to write code and run tests locally. It outlines: +If you're interested in contributing to arrow, this vignette explains our approach, +at a high-level. If you're looking for more detailed content, you may want to +look at one of the following links: -* how to build the components that make up the Arrow project and R package -* workflows that developers use -* some common troubleshooting steps and solutions +* [setting up a development environment and building the components that make up the Arrow project and R package](https://arrow.apache.org/docs/r/articles/developers/setup.html) +* [common Arrow dev workflow tasks](https://arrow.apache.org/docs/r/articles/developers/workflow.html) +* [running R with the C++ debugger attached](https://arrow.apache.org/docs/r/articles/developers/debugging.html) -This document is intended only for **developers** of Apache Arrow or the Arrow R package. R package users do not need to do any of this setup. If you're looking for how to install Arrow, see [the instructions in the readme](https://arrow.apache.org/docs/r/#installation). +# Approach to implementing functionality -This document is a work in progress and will grow and change as the Apache Arrow project grows and changes. We have tried to make these steps as robust as possible (in fact, we even test exactly these instructions on our nightly CI to ensure they don't become stale!), but custom configurations might conflict with these instructions and there are differences of opinion across developers about how to set up development environments like this. +Our general philosophy when implementing functionality is to match to existing +R function signatures which may be familiar to users, whilst exposing any +additional functionality available via Arrow. The intention is to allow users +to be able to use their existing code with minimal changes, or new code or +approaches to learn. Review comment: Nice, I like this rephrasing -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
