Contributing

Contribute to NURL project.

• Follow the main CONTRIBUTING.md ruleset

Contribute to web documentation

• Fumadocs powers the web documentation
• All NURL documentation is under webdocs/content/docs/

You can freely contribute to the web documentation with the following rules:

• Follow the main CONTRIBUTING.md ruleset
• Web documentation is different from the repository documentation. Developers manage it by hand. The repository documentation changes rapidly because the project is in an early state. Automation may come later.
• The web documentation is simple to understand and broad in content. The repository documentation is minimal and technical.
• You may use AI for web documentation contributions, with limits. If you use AI, you take full responsibility for the commit. You must tell us about any automation in the pull request. This includes LLM-based AI tools.
• If you contribute low-quality or misleading information, the developers may reject all your future contributions.

How To

Below is a simple way to make edits and additions.

1. Fork and clone the NURL repository
2. Set the upstream repository:

   git remote add upstream git@github.com:nurl-lang/nurl.git

3. Create a new branch from the main branch:

   # Have the latest upstream changes
   git fetch upstream
   
   # Create and switch to a new branch
   git switch --create webdocs-update-describechange upstream/main

4. Make your changes
5. Commit with the following message structure: web docs: changedescribedhere
6. Push your commits to your fork:

   git push --set-upstream origin HEAD

7. Create a pull request.