Skip to content

Conversation

ShabiShett07
Copy link
Contributor


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: na
  • 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 ---

type: pre_push_report
description: Results of running various checks prior to pushing changes. report:

  • task: run_javascript_examples status: na
  • task: run_c_examples status: na
  • task: run_cpp_examples status: na
  • task: run_javascript_readme_examples status: na
  • task: run_c_benchmarks status: na
  • task: run_cpp_benchmarks status: na
  • task: run_fortran_benchmarks status: na
  • task: run_javascript_benchmarks status: na
  • task: run_julia_benchmarks status: na
  • task: run_python_benchmarks status: na
  • task: run_r_benchmarks status: na
  • task: run_javascript_tests status: na ---

none

Description

What is the purpose of this pull request?

This pull request:

  • {Adds a FAQ for contributing FAQs document

Related Issues

Does this pull request have any related issues?

This pull request:

  • none

Questions

Any questions for reviewers of this pull request?

No.

Other

Any other information relevant to this pull request? This may include screenshots, references, and/or implementation notes.

No.

Checklist

Please ensure the following tasks are completed before submitting this pull request.


@stdlib-js/reviewers

---
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: na
  - 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
---

---
type: pre_push_report
description: Results of running various checks prior to pushing changes.
report:
  - task: run_javascript_examples
    status: na
  - task: run_c_examples
    status: na
  - task: run_cpp_examples
    status: na
  - task: run_javascript_readme_examples
    status: na
  - task: run_c_benchmarks
    status: na
  - task: run_cpp_benchmarks
    status: na
  - task: run_fortran_benchmarks
    status: na
  - task: run_javascript_benchmarks
    status: na
  - task: run_julia_benchmarks
    status: na
  - task: run_python_benchmarks
    status: na
  - task: run_r_benchmarks
    status: na
  - task: run_javascript_tests
    status: na
---
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label Mar 18, 2025
@ShabiShett07
Copy link
Contributor Author

@aayush0325, please check this FAQ.

Also I think we should have a FAQ for max length in javascript files too. What is your opinion?

@kgryte kgryte added the Documentation Improvements, additions, or changes to documentation. label Mar 19, 2025
Signed-off-by: Shabareesh Shetty <[email protected]>
@ShabiShett07
Copy link
Contributor Author

@aayush0325, I have added reference links as well as a FAQ for max length of javascript. Also I have removed a TODO in line 68 because I thought it was outdated. Please check if I am right.

Signed-off-by: Shabareesh Shetty <[email protected]>
Signed-off-by: Shabareesh Shetty <[email protected]>
@aayush0325 aayush0325 mentioned this pull request Mar 20, 2025
1 task
ShabiShett07 and others added 5 commits March 20, 2025 22:17
Co-authored-by: Karan Anand <[email protected]>
Signed-off-by: Shabareesh Shetty <[email protected]>
Co-authored-by: Karan Anand <[email protected]>
Signed-off-by: Shabareesh Shetty <[email protected]>
Co-authored-by: Karan Anand <[email protected]>
Signed-off-by: Shabareesh Shetty <[email protected]>
Co-authored-by: Karan Anand <[email protected]>
Signed-off-by: Shabareesh Shetty <[email protected]>
Co-authored-by: Karan Anand <[email protected]>
Signed-off-by: Shabareesh Shetty <[email protected]>
Co-authored-by: Karan Anand <[email protected]>
Signed-off-by: Shabareesh Shetty <[email protected]>
Copy link
Contributor

@anandkaranubc anandkaranubc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some last changes :) @ShabiShett07

Let's also change the title to:

docs: add FAQ for linting errors

@ShabiShett07 ShabiShett07 changed the title docs: add a FAQ for contributing FAQs document docs: add FAQ for linting errors Mar 21, 2025
@ShabiShett07
Copy link
Contributor Author

Some last changes :) @ShabiShett07

Let's also change the title to:

docs: add FAQ for linting errors

I have changed the title

Copy link
Contributor

@anandkaranubc anandkaranubc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The above comments still need to be resolved first.

@anandkaranubc anandkaranubc added Needs Changes Pull request which needs changes before being merged. and removed Needs Review A pull request which needs code review. labels Mar 21, 2025
ShabiShett07 and others added 4 commits March 21, 2025 16:39
Co-authored-by: Karan Anand <[email protected]>
Signed-off-by: Shabareesh Shetty <[email protected]>
Co-authored-by: Karan Anand <[email protected]>
Signed-off-by: Shabareesh Shetty <[email protected]>
Co-authored-by: Karan Anand <[email protected]>
Signed-off-by: Shabareesh Shetty <[email protected]>
Co-authored-by: Karan Anand <[email protected]>
Signed-off-by: Shabareesh Shetty <[email protected]>
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label Mar 21, 2025
@ShabiShett07
Copy link
Contributor Author

@anandkaranubc, I think I have solved all your comments, sorry for not noticing the comments

@anandkaranubc anandkaranubc requested a review from kgryte March 21, 2025 11:39
@Planeshifter Planeshifter added the Ready To Merge A pull request which is ready to be merged. label Mar 24, 2025
@stdlib-bot stdlib-bot removed the Needs Review A pull request which needs code review. label Mar 24, 2025
@stdlib-bot
Copy link
Contributor

stdlib-bot commented Mar 24, 2025

PR Commit Message

docs: add FAQ for linting errors

PR-URL: https://github.com/stdlib-js/stdlib/pull/6157

Co-authored-by: Karan Anand <[email protected]>
Signed-off-by: Karan Anand <[email protected]>
Signed-off-by: Shabareesh Shetty <[email protected]>
Reviewed-by: Karan Anand <[email protected]>
Reviewed-by: Philipp Burckhardt <[email protected]>

Please review the above commit message and make any necessary adjustments.

@stdlib-bot stdlib-bot removed the Needs Changes Pull request which needs changes before being merged. label Mar 24, 2025
@Planeshifter Planeshifter merged commit 86614b9 into stdlib-js:develop Mar 24, 2025
28 checks passed
sahil20021008 pushed a commit to sahil20021008/stdlib that referenced this pull request Mar 26, 2025
PR-URL: stdlib-js#6157

Co-authored-by: Karan Anand <[email protected]>
Signed-off-by: Karan Anand <[email protected]>
Signed-off-by: Shabareesh Shetty <[email protected]>
Reviewed-by: Karan Anand <[email protected]>
Reviewed-by: Philipp Burckhardt <[email protected]>
@ShabiShett07 ShabiShett07 deleted the contributing-faqs-doc branch April 3, 2025 04:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Improvements, additions, or changes to documentation. Ready To Merge A pull request which is ready to be merged.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants