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

[RFC]: update the contributing to explicitly require running make install #1678

Closed
3 tasks done
Shashankss1205 opened this issue Mar 3, 2024 · 3 comments
Closed
3 tasks done
Labels
Documentation Improvements, additions, or changes to documentation. RFC Request for comments. Feature requests and proposed changes.

Comments

@Shashankss1205
Copy link
Contributor

Shashankss1205 commented Mar 3, 2024

Description

This RFC proposes to add the install command:

$ make install-node-modules

before the initialisation command:

$ make init

used for testing in Step-6: Test of Contributing Guidelines.

This ensures that a person setting-up the repository for the first-time as a contributor doesn't receive an initialisation error while testing.

Related Issues

No

Questions

No.

Other

No.

Checklist

  • I have read and understood the Code of Conduct.
  • Searched for existing issues and pull requests.
  • The issue name begins with RFC:.
@kgryte kgryte changed the title [RFC]: Documentation Enhancement for https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md [RFC]: update the contributing to explicitly require running make install Mar 4, 2024
@kgryte
Copy link
Member

kgryte commented Mar 4, 2024

@Shashankss1205 Thanks for posting this issue. Yes, we should likely be more explicit here.

In https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md#code, we explicitly ask that contributors follow the Development Guide, which has contributors run make install before make init, but it is likely that people will gloss over those links and move on immediately to the listed steps in the contributing guide. Meaning, we should anticipate that individuals will not follow instructions and save ourselves the headache of common dev questions.

@kgryte kgryte added RFC Request for comments. Feature requests and proposed changes. Documentation Improvements, additions, or changes to documentation. labels Mar 4, 2024
@Shashankss1205
Copy link
Contributor Author

Thanks For your valuable insights into this issue @kgryte , shall I change it similar to the image attached and send it as a PR ?
Screenshot (231)

@Shashankss1205
Copy link
Contributor Author

Please suggest if that's like how you want this to be @kgryte

@kgryte kgryte closed this as completed in 105db06 Mar 20, 2024
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. RFC Request for comments. Feature requests and proposed changes.
Projects
None yet
Development

No branches or pull requests

2 participants