Skip to main content

Contributing

Neko is an open-source project, and we welcome contributions from the community. Whether you're a developer, designer, or user, you can help improve Neko by reporting bugs, suggesting new features, or submitting code changes.

Reporting Issues

If you encounter a bug or have a feature request, please open a new issue on the GitHub repository. Before opening an issue, please check if a similar issue has already been reported and ensure you read the Troubleshooting Guide and the FAQ to see if your issue has already been addressed.

When reporting an issue, please provide as much information as possible, including:

  • A detailed description of the problem
  • Steps to reproduce the issue
  • Expected behavior
  • Actual behavior
  • Screenshots or error messages (if applicable)
  • Your operating system and browser version

Contributing Code

If you're a developer and want to contribute code to Neko, follow these steps:

  1. Fork the project: Create a personal copy of the repository by forking it to your GitHub account.

  2. Edit files in your branch: Make your changes in a new branch created from the master branch. Ensure your changes are well-documented and tested.

  3. Submit a pull request: Once your changes are ready, submit a pull request with a detailed explanation of the improvements and any relevant information for the reviewers.

Make sure you read the Developer Guide for more information on the code structure and development process.