Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CONTRIBUTING.md is unclear about standard library #53200

Open
araujoms opened this issue Feb 6, 2024 · 10 comments
Open

CONTRIBUTING.md is unclear about standard library #53200

araujoms opened this issue Feb 6, 2024 · 10 comments
Labels
docs This change adds or pertains to documentation

Comments

@araujoms
Copy link
Contributor

araujoms commented Feb 6, 2024

I just submitted a PR to change something in LinearAlgebra (#53186). To do that I followed the instructions here about how to contribute to the standard library, which didn't work. @jishnub then kindly remarked that I should instead follow the instructions for contributing to the core functionality or base libraries, which did work.

Either the instructions are incorrect or LinearAlgebra is not part of the standard library, despite being in the stdlib folder. Either way I think the documentation should be updated.

@ViralBShah
Copy link
Member

ViralBShah commented Feb 7, 2024

Based on your experience, do you have a set of instructions that you can provide in a PR to CONTRIBUTING.md?

@araujoms

This comment was marked as outdated.

@vtjnash
Copy link
Member

vtjnash commented Feb 7, 2024

Sounds like we should try to clarify here the list of stdlibs that can be upgraded that way (e.g. make print-STDLIBS_WITHIN_SYSIMG), and those that cannot? as well as those that are in a separate repo (and can use USE_DEPS=<names> in Make.user) vs those that are edited directly here?

@araujoms

This comment was marked as outdated.

@ViralBShah

This comment was marked as outdated.

@inkydragon

This comment was marked as outdated.

@inkydragon inkydragon added the docs This change adds or pertains to documentation label Feb 7, 2024
@vtjnash

This comment was marked as outdated.

@ViralBShah

This comment was marked as outdated.

@KristofferC

This comment was marked as outdated.

@vtjnash
Copy link
Member

vtjnash commented Feb 8, 2024

Hid a side-conversation about LinearAlgebra having a separate repo, since the resolution was that we deleted it now, and it detracts from the main conversation here about docs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This change adds or pertains to documentation
Projects
None yet
Development

No branches or pull requests

5 participants