You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/CONTRIBUTING.md
+5-6Lines changed: 5 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,8 +2,7 @@
2
2
3
3
Thanks for reading! We love contributions from everyone in the form of good discussion, issues, and pull requests.
4
4
5
-
This is the short version. There's more information on the [wiki](https://github.com/stan-dev/math/wiki/Developer-Doc#contributing).
6
-
5
+
This is the short version. There's more information on the [documentation site](https://mc-stan.org/math/developer_guide.html).
7
6
## Issues
8
7
9
8
We reserve [issues](https://github.com/stan-dev/math/issues) for bugs and feature requests that are defined well enough for a developer to tackle. If you have general questions about the Math library, please see the [Discussion](#discussion) section.
@@ -31,22 +30,22 @@ Open feature requests should be the ones we want to implement in the Math librar
31
30
32
31
## Pull Requests
33
32
34
-
All changes to the Math library are handled through [pull requests](https://github.com/stan-dev/math/pulls). Each pull request should correspond to an issue. We follow a [modified GitFlow branching model](https://github.com/stan-dev/stan/wiki/Dev:-Git-Process) for development.
33
+
All changes to the Math library are handled through [pull requests](https://github.com/stan-dev/math/pulls). Each pull request should correspond to an issue. We follow a [modified GitFlow branching model](https://github.com/stan-dev/stan/wiki/Developer-process-overview#2-create-a-branch-for-the-issue) for development.
35
34
36
35
When a contributor creates a pull request for inclusion to the Math library, here are some of the things we expect:
37
36
38
-
1. the contribution maintains the Math library's open-source [license](https://github.com/stan-dev/math/wiki/Developer-Doc#licensing): 3-clause BSD
37
+
1. the contribution maintains the Math library's open-source [license](https://github.com/stan-dev/stan/wiki/Stan-Licensing): 3-clause BSD
39
38
2. the code base remains stable after merging the pull request; we expect the `develop` branch to always be in a good state
40
39
3. the changes are maintainable. In code review, we look at the design of the proposed code. We also expect documentation. It should look like idiomatic C++.
41
40
4. the changes are tested. For bugs, we expect at least one test that fails before the patch and is fixed after the patch. For new features, we expect at least one test that shows expected behavior and one test that shows the behavior when there's an error.
42
-
5. the changes adhere to the Math library's [C++ standards](https://github.com/stan-dev/stan/wiki/Code-Quality). Consistency really helps.
41
+
5. the changes adhere to the Math library's [C++ standards](https://github.com/stan-dev/stan/wiki/Coding-Style-and-Idioms). Consistency really helps.
43
42
44
43
Pull requests are code reviewed after they pass our continuous integration tests. We expect all the above before a pull request is merged. We are an open-source project and once code makes it into the repository, it's on the community to maintain.
45
44
46
45
It is the responsibility of the contributor submitting the pull request that the code meets these requirements. We're open-source. Once the code gets into the code base, the community of developers take ownership of it.
47
46
48
47
### Code Reviews
49
-
See the [Code Review Guidelines](https://github.com/stan-dev/math/wiki/Developer-Doc#code-review-guidelines) on the Math wiki.
48
+
See the [Code Review Guidelines](https://github.com/stan-dev/stan/wiki/Developer-process-overview#code-review-guidelines) on the Math wiki.
Copy file name to clipboardExpand all lines: .github/PULL_REQUEST_TEMPLATE.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
Thanks for submitting a pull request! Please remove this text when submitting.
2
2
3
-
Start by filling in the Summary, Tests, and Side Effects sections of this pull request and then work through the handy checklist at the bottom. If anything significant is missing, the pull request may be closed until it's ready. The full guidebook on how pull requests are reviewed is here: [Code Review Guidelines](https://github.com/stan-dev/math/wiki/Developer-Doc#code-review-guidelines).
3
+
Start by filling in the Summary, Tests, and Side Effects sections of this pull request and then work through the handy checklist at the bottom. If anything significant is missing, the pull request may be closed until it's ready. The full guidebook on how pull requests are reviewed is here: [Code Review Guidelines](https://github.com/stan-dev/stan/wiki/Developer-process-overview#code-review-guidelines).
4
4
5
5
## Summary
6
6
@@ -40,7 +40,7 @@ Replace this text with a short note on what will change if this pull request is
Copy file name to clipboardExpand all lines: doxygen/contributor_help_pages/developer_doc.md
+21-18Lines changed: 21 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -43,11 +43,7 @@ We're committed to having a permissive open-source license. The Math library is
43
43
44
44
# Contributing {#contribution}
45
45
46
-
Thanks for reading! We love contributions from everyone in the form of discussions, issues, and pull requests.
47
-
48
-
This is the short version. There's more information on the [wiki](https://github.com/stan-dev/math/wiki/Developer-Doc#contributing).
49
-
50
-
It is the responsibility of the contributor submitting the pull request that the code meets these requirements. We're open-source. Once the code gets into the code base, the community of developers take ownership of it.
46
+
Thanks for reading! We love contributions from everyone in the form of good discussion, issues, and pull requests.
51
47
52
48
## Issues
53
49
@@ -76,30 +72,31 @@ Open feature requests should be the ones we want to implement in the Math librar
76
72
77
73
## Pull Requests
78
74
79
-
All changes to the Math library are handled through [pull requests](https://github.com/stan-dev/math/pulls). Each pull request should correspond to an issue. We follow a [modified GitFlow branching model](https://github.com/stan-dev/stan/wiki/Dev:-Git-Process) for development.
75
+
All changes to the Math library are handled through [pull requests](https://github.com/stan-dev/math/pulls). Each pull request should correspond to an issue. We follow a [modified GitFlow branching model](https://github.com/stan-dev/stan/wiki/Developer-process-overview#2-create-a-branch-for-the-issue) for development.
80
76
81
77
When a contributor creates a pull request for inclusion to the Math library, here are some of the things we expect:
82
78
83
-
1. the contribution maintains the Math library's open-source [license](https://github.com/stan-dev/math/wiki/Developer-Doc#licensing): 3-clause BSD
79
+
1. the contribution maintains the Math library's open-source [license](https://github.com/stan-dev/stan/wiki/Stan-Licensing): 3-clause BSD
84
80
2. the code base remains stable after merging the pull request; we expect the `develop` branch to always be in a good state
85
-
3. the changes are maintainable. In code review, we look at the design of the proposed code. We also expect documentation.
81
+
3. the changes are maintainable. In code review, we look at the design of the proposed code. We also expect documentation. It should look like idiomatic C++.
86
82
4. the changes are tested. For bugs, we expect at least one test that fails before the patch and is fixed after the patch. For new features, we expect at least one test that shows expected behavior and one test that shows the behavior when there's an error.
87
-
5. the changes adhere to the Math library's [C++ standards](https://github.com/stan-dev/stan/wiki/Code-Quality). Consistency really helps.
83
+
5. the changes adhere to the Math library's [C++ standards](https://github.com/stan-dev/stan/wiki/Coding-Style-and-Idioms). Consistency really helps.
88
84
89
85
Pull requests are code reviewed after they pass our continuous integration tests. We expect all the above before a pull request is merged. We are an open-source project and once code makes it into the repository, it's on the community to maintain.
90
86
91
-
### Code Reviews
92
-
See the [Code Review Guidelines](https://github.com/stan-dev/math/wiki/Developer-Doc#code-review-guidelines) on the Math wiki.
93
-
87
+
It is the responsibility of the contributor submitting the pull request that the code meets these requirements. We're open-source. Once the code gets into the code base, the community of developers take ownership of it.
94
88
95
-
## Discussion {#discussion}
96
89
97
-
For general questions, please ask on the forums with the ["Developers" tag](https://discourse.mc-stan.org/c/stan-dev).
90
+
## Discussion
98
91
92
+
For general questions, please ask on the forums with the ["Developers" tag](http://discourse.mc-stan.org/c/stan-dev).
1. clear licensing information. Check that the person that owns the copyright is listed.
@@ -109,7 +106,7 @@ All pull requests must have these things:
109
106
- code design. It should either be designed with well-known C++ patterns or there should be a good reason it isn't.
110
107
- documentation. The documentation that goes with the changes should go in this pull request.
111
108
4. the changes are tested. Please verify that there's at least one new test that forces the code to execute. Please also verify there's at least one test that shows how to handle errors in the code. Having just these two tests (without full coverage) is usually enough to trap errors in the future. It is also enough to use these to refactor the code when the time comes.
112
-
5. the changes adhere to the Math library's [C++ standards](https://github.com/stan-dev/stan/wiki/Code-Quality). This is a large code base. We want the quality to be consistent so it's easy to navigate and understand other parts of the code base.
109
+
5. the changes adhere to the Math library's [C++ standards](https://github.com/stan-dev/stan/wiki/Coding-Style-and-Idioms). This is a large code base. We want the quality to be consistent so it's easy to navigate and understand other parts of the code base.
113
110
114
111
Most of the above is subjective, so please use your best judgement.
115
112
@@ -280,14 +277,20 @@ The easiest way to build and run tests is to use the `runTests.py` python script
280
277
281
278
## Misc: Stan Testing
282
279
283
-
The [Stan testing](https://github.com/stan-dev/stan/wiki/Testing-Stan-using-Gnu-Make-and-Python) process depends on the makefiles in Math.
280
+
The [Stan testing](https://github.com/stan-dev/stan/wiki/Coding-Style-and-Idioms#unit-testing) process depends on the makefiles in Math.
284
281
285
282
286
283
287
284
# Where do I create a new issue
288
285
289
-
Stan's development is across multiple repositories. See this page for details on where to put new issues:
Note: clang + linux long had issues with `thread_local` which should be fixed with clang >=4.0
38
38
39
39
## Mac OS X
@@ -58,4 +58,4 @@ With `clang` on linux there are issues during the linking step of programs which
58
58
59
59
Known to work:
60
60
- RTools 3.5 for Windows which uses mingw g++ 4.9.1 (since stan-math 2.20.0)
61
-
- RTools 4.0 for Windows with a port of GNU g++ 8.2 see [here](https://github.com/stan-dev/rstan/wiki/Using-RStan-with-the-R-3.6.0-Prerelease-on-Windows) but that compiler can also be used with CmdStan
61
+
- RTools 4.0 for Windows with a port of GNU g++ 8.2, that compiler can also be used with CmdStan
0 commit comments