Skip to content

Latest commit

 

History

History
65 lines (46 loc) · 2.67 KB

CONTRIBUTING.md

File metadata and controls

65 lines (46 loc) · 2.67 KB
Raw

Contributing to ntscli

Thank you for considering contributing to ntscli! We welcome contributions from the community to make this project better.

Before you get started, please take a moment to review the following guidelines.

Table of Contents

Code of Conduct

Please read and adhere to our Code of Conduct before contributing. We want all contributors to be respectful and considerate of each other.

How to Contribute

  1. Fork the repository to your GitHub account.
  2. Clone your forked repository to your local machine.
  3. Create a new branch for your feature or bugfix: git checkout -b feature/my-new-feature or git checkout -b bugfix/issue-number.
  4. Make your changes and commit them with a clear and descriptive message.
  5. Push your changes to your forked repository: git push origin feature/my-new-feature.
  6. Open a pull request to the main branch of this repository.
  7. Ensure that your pull request includes clear documentation and/or tests for your changes.

Reporting Bugs

If you find a bug or issue in the project, please open a GitHub issue and include the following information:

  • A clear and descriptive title.
  • Steps to reproduce the issue.
  • Expected behavior.
  • Actual behavior.
  • Any relevant screenshots or error messages.

Feature Requests

If you have an idea for a new feature or enhancement, please open a GitHub issue and provide the following details:

  • A clear and descriptive title.
  • A detailed description of the feature.
  • Any relevant use cases or examples.

Pull Request Process

  1. Ensure that your code follows the coding standards outlined in Coding Standards.
  2. Keep your pull request focused on a single feature or bugfix.
  3. Provide clear documentation and/or tests for your changes.
  4. Ensure your code is well-commented.
  5. Rebase your branch on the latest main before submitting your pull request.
  6. Include a clear and concise description of your changes in the pull request.
  7. Be responsive to feedback and comments on your pull request.

Coding Standards

Please follow the coding standards and style guidelines defined in our STYLE_GUIDELINES.md document.

License

By contributing to this project, you agree that your contributions will be licensed under the LICENSE of the project. Make sure to read and understand the license before contributing.

Thank you for your contribution to ntscli!