Skip to content

Commit 36da8f9

Browse files
committed
docs: move contributing documentation to a sub-folder
--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent 961bd1a commit 36da8f9

16 files changed

+44
-25
lines changed

.github/workflows/autoclose.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ jobs:
5858
BODY: |
5959
Thank you for working on this pull request. However, we cannot accept your contribution as this pull request does not follow our [contributing guidelines](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md).
6060
61-
Per the guidelines outlined in our [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md), you should download and setup [EditorConfig](http://editorconfig.org/) to ensure that files are automatically configured to use expected indentation and line endings.
61+
Per the guidelines outlined in our [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/contributing/development.md), you should download and setup [EditorConfig](http://editorconfig.org/) to ensure that files are automatically configured to use expected indentation and line endings.
6262
6363
If you would prefer to avoid manual setup, you could also consider using a pre-configured [development container](https://github.com/stdlib-js/stdlib/tree/develop/.devcontainer) for use locally or in GitHub Codespaces.
6464
@@ -94,7 +94,7 @@ jobs:
9494
BODY: |
9595
Thank you for working on this pull request. However, we cannot accept your contribution as this pull request does not follow our [contributing guidelines](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md).
9696
97-
Per the guidelines outlined in our [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md), you should have setup your local development environment such that automated development processes for linting, license verification, and unit testing can run prior to authoring commits and pushing changes. We encourage you to refer to that guide **before** continuing to work on this pull request.
97+
Per the guidelines outlined in our [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/contributing/development.md), you should have setup your local development environment such that automated development processes for linting, license verification, and unit testing can run prior to authoring commits and pushing changes. We encourage you to refer to that guide **before** continuing to work on this pull request.
9898
9999
If you would prefer to avoid manual setup, you could also consider using a pre-configured [development container](https://github.com/stdlib-js/stdlib/tree/develop/.devcontainer) for use locally or in GitHub Codespaces.
100100

.github/workflows/good_first_issue.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ jobs:
6565
1. **You cannot "claim" issues.** People new to open source often want to "claim" or be assigned an issue before beginning work. The typical rationale is that people want to avoid wasted work in the event that someone else ends up working the issue. However, this practice is not effective in open source, as it often leads to "issue squatting", in which an individual asks to be assigned, is granted their request, and then never ends up working on the issue. Accordingly, you are encouraged to communicate your intent to address this issue, ideally by providing a rough outline as to how you plan to address the issue or asking clarifying questions, but, at the end of the day, we will take running code and rough consensus in order to move forward quickly.
6666
2. **We have a very high bar for contributions.** We have very high standards for contributions and expect all contributions—whether new features, tests, or documentation—to be rigorous, thorough, and complete. Once a pull request is merged into stdlib, that contribution immediately becomes the collective responsibility of all maintainers of stdlib. When we merge code into stdlib, we are saying that we, the maintainers, commit to reviewing subsequent changes and making bugfixes to the code. Hence, in order to ensure future maintainability, this naturally leads to a higher standard of contribution.
6767
68-
Before working on this issue and opening a pull request, please read the project's [contributing guidelines](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md). These guidelines and the associated [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) provide important information, including links to stdlib's [Code of Conduct](https://github.com/stdlib-js/stdlib/blob/develop/CODE_OF_CONDUCT.md), license policy, and steps for setting up your local development environment.
68+
Before working on this issue and opening a pull request, please read the project's [contributing guidelines](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md). These guidelines and the associated [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/contributing/development.md) provide important information, including links to stdlib's [Code of Conduct](https://github.com/stdlib-js/stdlib/blob/develop/CODE_OF_CONDUCT.md), license policy, and steps for setting up your local development environment.
6969
7070
To reiterate, we **strongly** encourage you to refer to our contributing guides **before** beginning work on this issue. Failure to follow our guidelines significantly decreases the likelihood that you'll successfully contribute to stdlib and may result in automatic closure of a pull request without review.
7171

.tours/contributor-overview.tour

+2-2
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@
1414
"line": 1
1515
},
1616
{
17-
"file": "docs/development.md",
18-
"description": "To setup your development environment, follow the steps in the `docs/development.md` file or use the VSCode development container.",
17+
"file": "docs/contributing/development.md",
18+
"description": "To setup your development environment, follow the steps in the `docs/contributing/development.md` file or use the VSCode development container.",
1919
"line": 21
2020
},
2121
{

CONTRIBUTING.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -435,15 +435,15 @@ Phew. While the above may be a lot to remember, even for what seem like minor ch
435435

436436
[stdlib-style-guides-git]: https://github.com/stdlib-js/stdlib/blob/develop/docs/style-guides/git
437437

438-
[stdlib-doctest]: https://github.com/stdlib-js/stdlib/blob/develop/docs/doctest.md
438+
[stdlib-doctest]: https://github.com/stdlib-js/stdlib/blob/develop/docs/contributing/doctest.md
439439

440-
[stdlib-development]: https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md
440+
[stdlib-development]: https://github.com/stdlib-js/stdlib/blob/develop/docs/contributing/development.md
441441

442-
[stdlib-branching]: https://github.com/stdlib-js/stdlib/blob/develop/docs/branching.md
442+
[stdlib-branching]: https://github.com/stdlib-js/stdlib/blob/develop/docs/contributing/branching.md
443443

444-
[stdlib-packages]: https://github.com/stdlib-js/stdlib/blob/develop/docs/packages.md
444+
[stdlib-packages]: https://github.com/stdlib-js/stdlib/blob/develop/docs/contributing/packages.md
445445

446-
[stdlib-repl-text]: https://github.com/stdlib-js/stdlib/blob/develop/docs/repl_text.md
446+
[stdlib-repl-text]: https://github.com/stdlib-js/stdlib/blob/develop/docs/contributing/repl_text.md
447447

448448
[stdlib-faq]: https://github.com/stdlib-js/stdlib/blob/develop/FAQ.md
449449

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -766,7 +766,7 @@ Test and build infrastructure is generously provided by the following services:
766766
767767
[stdlib-contributing]: https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md
768768
769-
[stdlib-development]: https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md
769+
[stdlib-development]: https://github.com/stdlib-js/stdlib/blob/develop/docs/contributing/development.md
770770
771771
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
772772

docs/branching.md docs/contributing/branching.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ This project follows the branching model articulated in ["A successful Git branc
105105

106106
- Before merging a hotfix branch into the `master` branch, the changes **must** be peer reviewed and pass continuous integration tests.
107107

108-
- Once merged into `master`, if a release branch currently exists, submit a pull request against the `release` branch. Otherwise, submit a pull request against the `develop` branch. By merging a hotfix into a release branch, the hotfix changes should be propagated to the `develop` branch upon merging the release branch into the `develop` branch.
108+
- Once merged into `master`, if a release branch currently exists, submit a pull request against the `release` branch. Otherwise, submit a pull request against the `develop` branch. By merging a hotfix into a release branch, the hotfix changes should be propagated to the `develop` branch upon merging the release branch into the `develop` branch.
109109

110110
* * *
111111

docs/development.md docs/contributing/development.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -254,15 +254,14 @@ workshops workshops
254254
```bash
255255
$ make TESTS_FILTER=.*/<pattern>/.* test
256256
```
257-
257+
258258
with
259259
260260
<!-- run-disable -->
261261
262262
```bash
263263
$ make TESTS_FILTER=".*/<pattern>/.*" test
264264
```
265-
266265
267266
## Editors
268267

docs/doctest.md docs/contributing/doctest.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ The following guide sets forth doctest conventions for documenting expected beha
4848

4949
A doctest annotation is a syntactically valid language comment consisting of a **marker** and an **expected value**.
5050

51-
> **Note**: most of the following examples will be written in JavaScript which uses C-style comment syntax. While invariably biased toward JavaScript, the doctest annotation convention endeavors to be language agnostic and not limited to any particular comment style.
51+
> **Note**: most of the following examples will be written in JavaScript which uses C-style comment syntax. While invariably biased toward JavaScript, the doctest annotation convention endeavors to be language agnostic and not limited to any particular comment style.
5252
5353
Doctest annotations begin with one of three keyword markers (with limited exceptions documented below):
5454

@@ -129,7 +129,7 @@ swap( x, 0, 1 );
129129
// x => [ 2, 1 ]
130130
```
131131

132-
indicates that the two-element array to which `x` refers has been mutated after evaluation of the preceding expressions. In this case, as `swap()` returns a `boolean`, the `returns` keyword would not allow us to assert the more salient behavior of array mutation. By using the `{var} =>` convention, we can do so.
132+
indicates that the two-element array to which `x` refers has been mutated after evaluation of the preceding expressions. In this case, as `swap()` returns a `boolean`, the `returns` keyword would not allow us to assert the more salient behavior of array mutation. By using the `{var} =>` convention, we can do so.
133133

134134
The `e.g.,` and `{var} =>` prefixes can be used in combination. For example,
135135

@@ -602,7 +602,7 @@ var mat = foo();
602602
603603
indicates that `foo()` returns an `NxM` matrix containing a `2x2` sub-matrix beginning with the first row and second column whose contents, when expressed as a linear array, equal `1.14`, `-3.14`, `0.00`, and `0.50`.
604604
605-
Additionally, matrices can include wildcards. For example,
605+
Additionally, matrices can include wildcards. For example,
606606
607607
<!-- run-disable -->
608608
File renamed without changes.

docs/misc/javascript_quirks.md docs/contributing/javascript_quirks.md

+21-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,23 @@
1+
<!--
2+
3+
@license Apache-2.0
4+
5+
Copyright (c) 2025 The Stdlib Authors.
6+
7+
Licensed under the Apache License, Version 2.0 (the "License");
8+
you may not use this file except in compliance with the License.
9+
You may obtain a copy of the License at
10+
11+
http://www.apache.org/licenses/LICENSE-2.0
12+
13+
Unless required by applicable law or agreed to in writing, software
14+
distributed under the License is distributed on an "AS IS" BASIS,
15+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16+
See the License for the specific language governing permissions and
17+
limitations under the License.
18+
19+
-->
20+
121
# JavaScript Quirks
222

323
> A list of JavaScript quirks which should be kept in mind when writing implementations.
@@ -26,4 +46,4 @@
2646

2747
[java-math-round]: https://docs.oracle.com/javase/7/docs/api/java/lang/Math.html#round%28double%29
2848

29-
</section>
49+
</section>

docs/packages.md docs/contributing/packages.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ Once a package is complete and tested, you are ready to request that your contri
114114

115115
[stdlib-snippets]: https://github.com/stdlib-js/stdlib/tree/develop/tools/snippets
116116

117-
[stdlib-repl-text]: https://github.com/stdlib-js/stdlib/tree/develop/docs/repl_text.md
117+
[stdlib-repl-text]: https://github.com/stdlib-js/stdlib/tree/develop/docs/contributing/repl_text.md
118118

119119
</section>
120120

docs/repl_text.md docs/contributing/repl_text.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -535,7 +535,7 @@ A few notes:
535535
A short description.
536536
537537
...
538-
538+
539539
Examples
540540
--------
541541
> var out = {{alias}}( 'beep' )
@@ -555,7 +555,7 @@ A few notes:
555555
A short description.
556556
557557
...
558-
558+
559559
Examples
560560
--------
561561
> var out = {{alias}}( {{alias:@stdlib/constants/math/float64-pi}} )
File renamed without changes.

docs/links/database.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -8993,7 +8993,7 @@
89938993
"policy"
89948994
]
89958995
},
8996-
"https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md": {
8996+
"https://github.com/stdlib-js/stdlib/blob/develop/docs/contributing/development.md": {
89978997
"id": "stdlib-development",
89988998
"description": "The stdlib development guidelines.",
89998999
"short_url": "",

etc/typedoc/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -473,7 +473,7 @@ Copyright © 2016-2021. The Stdlib [Authors][stdlib-authors].
473473

474474
[stdlib-contributing]: https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md
475475

476-
[stdlib-development]: https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md
476+
[stdlib-development]: https://github.com/stdlib-js/stdlib/blob/develop/docs/contributing/development.md
477477

478478
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
479479

lib/node_modules/@stdlib/_tools/scripts/publish_packages.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ var END_PKG_INDEX = ( flags[ 'end-index' ] === void 0 ) ? 9999 : parseInt( flags
7676
var MAX_TREE_DEPTH = 99;
7777
var KEEP_ALIVE_SAMPLE_SIZE = 1000;
7878

79-
var topics = setTopics.factory( {
79+
var topics = setTopics.factory({
8080
'token': ENV.GITHUB_TOKEN
8181
}, onTopics );
8282

@@ -199,7 +199,7 @@ var PULL_REQUEST_TEMPLATE = [
199199
'',
200200
'We are excited about your pull request, but unfortunately we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). We kindly request that you submit this pull request against the [respective directory](<pkg-path>) of the main repository where we’ll review and provide feedback. ',
201201
'',
202-
'If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib.',
202+
'If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/contributing/development.md) for help on developing stdlib.',
203203
'',
204204
'We look forward to receiving your contribution! :smiley:'
205205
].join( '\n' );

0 commit comments

Comments
 (0)