Skip to content

Latest commit

 

History

History
69 lines (45 loc) · 2.13 KB

CONTRIBUTING.md

File metadata and controls

69 lines (45 loc) · 2.13 KB
Raw

Welcome to the Neko contribution guide.

Thank you for being so interested in contributing to Neko! We welcome contributions from the community to help make this project better. By contributing, you are helping us improve and grow this software.

Please take a moment to review this document to understand how you can contribute and be a part of our open-source community.

Table of Contents

Getting Started

  • Fork the Neko repository on GitHub.
  • Clone your fork to your local machine:
git clone https://github.com/yourusername/neko.git
  • Create a new branch for your contributions:
git checkout -b my-feature-branch
  • Make your changes and test them.
  • Commit your changes with descriptive commit messages:
git commit -m "Add feature X"
  • Push your changes to your fork:
git push origin my-feature-branch

Create a pull request from your fork to the main Neko repository on GitHub.

How to Contribute

You can contribute to Neko in various ways:

  • Add new features.
  • Fix bugs and issues.
  • Improve documentation.
  • Review and improve code.
  • Provide feedback on pull requests and issues.

Pull Request Guidelines

When submitting a pull request, please follow these guidelines:

  • Make sure your code is well-documented, and your changes do not break existing functionality.
  • Ensure that your code follows the existing coding style and conventions.
  • Write clear and concise commit messages.
  • Include tests that cover your code changes, where applicable.
  • Make sure your pull request addresses a specific issue or feature request. Reference the issue in the pull request description.
  • Be prepared to make changes or address feedback during the review process.

Reporting Issues

If you find a bug or have a feature request, please open an issue on the GitHub repository. When reporting issues, please provide as much detail as possible, including your operating system, browser, and a step-by-step description of the problem.