Skip to content

Commit c800182

Browse files
Merge pull request #388 from lorenzwalthert/contributing
- More on contributing advice (#388).
2 parents 8efd035 + c766df3 commit c800182

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

CONTRIBUTING.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,25 @@ The source code is organized as follows:
9292
| visit.R | Functions that apply functions to each level of nesting, either inside out or outside in. |
9393
| zzz.R | backport imports. |
9494

95+
## Obtaining contextual information
96+
97+
You may have problems understanding some code because documentation is minimal,
98+
some code / functions seem to solve problems you don't understand or handle
99+
cases that seem unreasonable or otherwise incomprehensible. You can resort to
100+
the following strategies:
101+
102+
* Use full-text search to see where functions are defined or called and how
103+
different parts of styler depend on it.
104+
* Use `$git blame` to see where changes were introduced. Look at the commit
105+
message, check changes that were made to the code in the same commit. If you
106+
are using the GUI of GitHub, you can easily obtain more contextual information
107+
such as the pull request with which a change was introdued. Often
108+
functionality was introduced with testing. So you can easily see which new
109+
tests are related to the new functionality. You can remvoe the changes in the
110+
source code and re-run the tests and see what fails and why.
111+
* Search Issues and Pull Requests on GitHub with the full text search. Make
112+
sure you also search for closed Issues and PRs.
113+
95114

96115
## High-level conventions
97116

0 commit comments

Comments
 (0)