Skip to content

Latest commit

 

History

History
33 lines (21 loc) · 1.67 KB

File metadata and controls

33 lines (21 loc) · 1.67 KB

Contributing to the NTARI Developer Portal

Thank you for helping improve the NTARI Developer Portal. This repository is maintained by the Network Theory Applied Research Institute (NTARI) as the authoritative home for NTARI developer-facing documentation.

What to Contribute

At this stage, contributions should focus on repository governance, documentation structure proposals, typo fixes, clarity improvements, and issue reports. Full documentation pages and handbook content should not be added until NTARI opens the relevant documentation area for review.

Documentation Contribution Guidelines

  • Use clear, concise Markdown that renders well on GitHub.
  • Keep pull requests focused on a single purpose.
  • Prefer small, reviewable changes over large unstructured updates.
  • Avoid adding confidential, private, or security-sensitive information.
  • Link related issues, discussions, or decisions when available.
  • Do not introduce documentation pages before the relevant section has been approved for creation.

Opening Issues

Use GitHub issues to report documentation gaps, broken links, inaccurate wording, repository configuration problems, or proposed improvements. Include enough context for maintainers to understand the requested change.

Pull Request Expectations

A good documentation pull request should include:

  1. A short summary of the change.
  2. The reason the change is needed.
  3. Any related issue or discussion links.
  4. Confirmation that the Markdown has been reviewed for readability.

Licensing

By contributing to this repository, you agree that your contributions will be licensed under the GNU Affero General Public License v3.0, as described in LICENSE.