Skip to content

Replace #8824: CONTRIBUTING.md for standard library#8894

Merged
amtoine merged 1 commit intonushell:mainfrom
bobhy:stdlib_contributing_1
Apr 17, 2023
Merged

Replace #8824: CONTRIBUTING.md for standard library#8894
amtoine merged 1 commit intonushell:mainfrom
bobhy:stdlib_contributing_1

Conversation

@bobhy
Copy link
Copy Markdown
Contributor

@bobhy bobhy commented Apr 15, 2023

Description

Replaces #8824, which was languishing in review limbo and becoming increasingly difficult to keep current with upstream changes.

In addition to all the edits, this PR includes updated documentation for running unit tests via std run-tests.

User-Facing Changes

A CONTRIBUTING.md documenting guidelines and getting started info for potential stdlib contributors.

Tests + Formatting

After Submitting

@codecov
Copy link
Copy Markdown

codecov bot commented Apr 15, 2023

Codecov Report

Merging #8894 (e51c1b2) into main (cbedc84) will increase coverage by 0.37%.
The diff coverage is 100.00%.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #8894      +/-   ##
==========================================
+ Coverage   68.15%   68.53%   +0.37%     
==========================================
  Files         636      636              
  Lines      101669   101676       +7     
==========================================
+ Hits        69292    69679     +387     
+ Misses      32377    31997     -380     
Impacted Files Coverage Δ
crates/nu-std/src/lib.rs 80.19% <100.00%> (+1.47%) ⬆️

... and 3 files with indirect coverage changes

@amtoine
Copy link
Copy Markdown
Member

amtoine commented Apr 16, 2023

should close #8810

@amtoine amtoine mentioned this pull request Apr 16, 2023
7 tasks
@amtoine amtoine linked an issue Apr 16, 2023 that may be closed by this pull request
@amtoine amtoine added category:documentation issues relating to documentation A:std-library Defining and improving the standard library written in Nu labels Apr 16, 2023
@amtoine
Copy link
Copy Markdown
Member

amtoine commented Apr 17, 2023

thanks @bobhy for the document 🥳 😋

@amtoine amtoine merged commit f82a1d8 into nushell:main Apr 17, 2023
@bobhy bobhy deleted the stdlib_contributing_1 branch April 17, 2023 17:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A:std-library Defining and improving the standard library written in Nu category:documentation issues relating to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

stdlib: write a CONTRIBUTING.md guidelines for developers

2 participants