Skip to main content

Contributing to NIKL

First off, thank you for considering contributing to the NIKL documentation! It's people like you that make open source such a great community.

How Can I Contribute?​

Reporting Bugs or Typos​

If you find a bug, typo, or unclear sentence, please open an issue and provide as much information as possible.

Suggesting Enhancements​

If you have an idea for a new documentation page or an improvement to an existing one, please open an issue to discuss it.

Pull Requests​

We welcome pull requests! Please follow these steps to make a contribution:

  1. Fork the repository to your own GitHub account.
  2. Clone the project to your machine.
  3. Create a new branch for your changes (git checkout -b my-new-feature).
  4. Make your changes and commit them with a clear, descriptive message.
  5. Push your branch to your fork (git push origin my-new-feature).
  6. Open a Pull Request from your branch to our main branch.

Thank you again for your contribution!