Skip to content

Commit d8df986

Browse files
Merge branch 'stdlib-js:develop' into feature/nanwmean
2 parents 4974c82 + 7ae0a0a commit d8df986

File tree

4,758 files changed

+103335
-94055
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

4,758 files changed

+103335
-94055
lines changed

CONTRIBUTORS

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,7 @@ Justyn Shelby <[email protected]>
7878
Karan Anand <[email protected]>
7979
Karthik Prakash <[email protected]>
8080
Kaushikgtm <[email protected]>
81+
Kavyansh-Bagdi <[email protected]>
8182
Kohantika Nath <[email protected]>
8283
Krishnam Agarwal <[email protected]>
8384
Krishnendu Das <[email protected]>
@@ -129,7 +130,9 @@ Rutam Kathale <[email protected]>
129130
Ruthwik Chikoti <[email protected]>
130131
Ryan Seal <[email protected]>
131132
Rylan Yang <[email protected]>
133+
SAHIL KUMAR <[email protected]>
132134
SHIVAM YADAV <[email protected]>
135+
Sahil Goyal <[email protected]>
133136
Sai Srikar Dumpeti <[email protected]>
134137
Sanchay Ketan Sinha <[email protected]>
135138
Sarthak Paandey <[email protected]>

docs/contributing/FAQ.md

Lines changed: 64 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,8 @@ limitations under the License.
2727
- [How can I set up my development environment to contribute to stdlib?](#setup-dev-environment)
2828
- [How can I install cppcheck?](#install-cppcheck)
2929
- [I am seeing different return values in the JavaScript and C implementation for the same implementation.](#js-vs-c-return-values)
30-
- [What should I do if Markdown linting on my commits fails because my headings exceed the maximum permissible length?](#markdown-heading-length)
30+
- [What should I do if linting on my commits fails because my headings or lines exceed the maximum permissible length?](#markdown-heading-length)
31+
- [What should I do if JavaScript linting on my commits fails because my function exceeds the maximum permissible number of parameters?](#max-params)
3132
- [I have opened a pull request, where can I seek feedback?](#pr-feedback)
3233
- [I need to generate fixtures for my tests. How can I do that, and what are the best references for inspiration?](#generate-fixtures)
3334
- [I am facing a `Shadowed declaration` linting error in my C files, how can I fix it?](#shadowed-declaration)
@@ -36,6 +37,7 @@ limitations under the License.
3637
- [When should I use decimals in examples, benchmarks, and documentation, and when should I avoid them?](#decimal-usage)
3738
- [How should I name my pull request?](#pr-naming)
3839
- [How do I call the stdlib bot on my PR?](#stdlib-bot)
40+
- [Why were many unrelated files automatically pushed to my PR when I committed my changes?](#auto-push)
3941
- [Frequently used `make` commands](#freq-make-commands)
4042
- [Other Links](#other-links)
4143

@@ -45,7 +47,7 @@ limitations under the License.
4547

4648
## Introduction
4749

48-
We appreciate your interest in contributing to stdlib! Below, weve compiled answers to some frequently asked questions (FAQs) from first-time contributors. If youre new to the project or encounter any challenges, this guide is a great place to start.
50+
We appreciate your interest in contributing to stdlib! Below, we've compiled answers to some frequently asked questions (FAQs) from first-time contributors. If you're new to the project or encounter any challenges, this guide is a great place to start.
4951

5052
<a name="first-time-contributor"></a>
5153

@@ -64,8 +66,6 @@ There are primarily two options for setting up your development environment to c
6466

6567
Note: The dev container does not yet support ARM64 architectures. For more information, or if you're interested in adding ARM64 support, you can visit this [issue][devcontainer-issue].
6668

67-
TODO: Modify the dev container setup link to the exact file link once it is merged.
68-
6969
<a name="install-cppcheck"></a>
7070

7171
## How can I install cppcheck?
@@ -101,15 +101,37 @@ If they pass, adjust the tolerance and add a note to the C tests indicating that
101101

102102
<a name="markdown-heading-length"></a>
103103

104-
## What should I do if Markdown linting on my commits fails because my headings exceed the maximum permissible length?
104+
## What should I do if linting on my commits fails because my headings or lines exceed the maximum permissible length?
105+
106+
Consider whether the heading/line can be shortened by renaming variables (e.g., changing `strideX` to `sx`). If shortening is not possible, disable the lint rule at the top level using:
107+
108+
- For JavaScript files:
109+
110+
```javascript
111+
// eslint-disable-line max-len
112+
```
105113

106-
Consider whether the heading can be shortened by renaming variables (e.g., changing `strideX` to `sx`). If shortening is not possible, disable the lint rule at the top level using:
114+
[Reference Comment][javascript-len-ref]
115+
116+
- For Markdown files:
107117

108118
```markdown
109119
<!-- lint disable maximum-heading-length -->
110120
```
111121

112-
TODO: Can we add a reference PR link?
122+
[Reference Comment][markdown-len-ref]
123+
124+
<a name="markdown-heading-length"></a>
125+
126+
## What should I do if JavaScript linting on my commits fails because my function exceeds the maximum permissible number of parameters?
127+
128+
Consider whether the number of parameters can be reduced. If reduction is not possible, disable the lint rule at the top level using:
129+
130+
```javascript
131+
// eslint-disable-line max-params
132+
```
133+
134+
[Reference Comment][javascript-params-ref]
113135

114136
<a name="pr-feedback"></a>
115137

@@ -269,6 +291,32 @@ Once you have created your PR, you can call the **stdlib-bot** to perform basic
269291

270292
To see other available bot commands, comment `/stdlib help` on your PR.
271293

294+
<a name="auto-push"></a>
295+
296+
## Why were many unrelated files automatically pushed to my PR when I committed my changes?
297+
298+
When you open a pull request or push changes to your feature branch, GitHub compares your feature branch against your `develop` branch and shows all the differences. If your feature branch contains outdated or extra changes, they will appear in the PR, even if they are unrelated to your work.
299+
300+
To fix this, ensure that your feature branch is based on the latest `develop` branch. You can do this by updating your local `develop` branch and then merging it into your feature branch:
301+
302+
```bash
303+
$ git checkout develop
304+
$ git pull upstream develop
305+
$ git push origin develop
306+
$ git checkout feature-branch
307+
$ git merge develop
308+
```
309+
310+
After merging, push your changes to the remote repository:
311+
312+
```bash
313+
$ git push origin feature-branch # git push also works
314+
```
315+
316+
> **Note**: When developing stdlib, we recommend using `merge` instead of `rebase` once a PR is open. Rebasing rewrites your branch history, which usually requires a force-push to update the remote branch. This can disrupt other contributors who are reviewing or collaborating on your PR. Since stdlib uses squash and merge for PRs, we don't require a clean, linear commit history. Merge commits are acceptable as long as your diff only contains relevant changes. If you want to learn more about rebasing/merging, you can refer to our [Git guide][git-guide].
317+
318+
Alternatively, you can call the **stdlib-bot** to merge changes from the `develop` branch into your PR. To do this, comment `/stdlib merge` on your PR.
319+
272320
<a name="freq-make-commands"></a>
273321

274322
## Frequently used `make` commands
@@ -334,6 +382,7 @@ For more `make` commands, refer to the [documentation][benchmark] on running ben
334382
## Other Links:
335383

336384
- [Style Guide][style-guide]
385+
- [Git Cheatsheet][git-guide]
337386
- [Other make commands][make-commands]
338387

339388
<section class="links">
@@ -346,6 +395,8 @@ For more `make` commands, refer to the [documentation][benchmark] on running ben
346395

347396
[github-fork]: https://help.github.com/articles/fork-a-repo/
348397

398+
[git-guide]: https://github.com/stdlib-js/stdlib/blob/develop/docs/contributing/git_cheatsheet.md#integration
399+
349400
[development-guide]: https://github.com/stdlib-js/stdlib/blob/develop/docs/contributing/development.md
350401

351402
[contributing-guide]: https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md
@@ -386,6 +437,12 @@ For more `make` commands, refer to the [documentation][benchmark] on running ben
386437

387438
[make-commands]: https://github.com/stdlib-js/stdlib/tree/develop/tools/make/lib
388439

440+
[markdown-len-ref]: https://github.com/stdlib-js/stdlib/blob/78e0cfd8b6c0429a443b07fd39fa9dd53bf44d23/lib/node_modules/%40stdlib/lapack/base/dgttrf/README.md?plain=1#L94
441+
442+
[javascript-len-ref]: https://github.com/stdlib-js/stdlib/blob/78e0cfd8b6c0429a443b07fd39fa9dd53bf44d23/lib/node_modules/%40stdlib/lapack/base/dgttrf/lib/base.js#L111
443+
444+
[javascript-params-ref]: https://github.com/stdlib-js/stdlib/blob/78e0cfd8b6c0429a443b07fd39fa9dd53bf44d23/lib/node_modules/%40stdlib/lapack/base/dgttrf/lib/base.js#L75
445+
389446
</section>
390447

391448
<!-- /.links -->

0 commit comments

Comments
 (0)