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

Clava-JS README is outdated/incomplete #179

Open
Guilherme-Soares-Sequeira opened this issue Feb 6, 2025 · 1 comment
Open

Clava-JS README is outdated/incomplete #179

Guilherme-Soares-Sequeira opened this issue Feb 6, 2025 · 1 comment

Comments

@Guilherme-Soares-Sequeira

The README is an important piece of documentation, especially for smoothing out the onboarding process of future contributors. Currently there are various missing pieces of information which are easy to add, namely:

  • The package.json code provided has a trailing comma which is not supported by node at the time of writing
  • The NPM development flow section could be expanded upon with, for example, the need to run npm run java-dist so that changes made in the JS side of the API are reflected in the Java version of Clava
  • Node and Java version constraints are not mentioned
  • Personally, I think a succinct walk-through of the directory structure, including a brief description of important directories, would greatly help new contributors
@lm-sousa
Copy link
Member

lm-sousa commented Feb 9, 2025

I agree. There is a dire need for better documentation.
If you are willing/able to contribute to this effort (and I noticed you self-assigned this issue) I would gladly review the documentation changes to make sure they are accurate and complete.
Otherwise I will only be able to change this in about a month's time.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants