Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
58 lines (38 loc) · 1.7 KB

CONTRIBUTING.md

File metadata and controls

58 lines (38 loc) · 1.7 KB
Raw

Contributing to Nexcage

Thank you for your interest in contributing to Nexcage! This document provides information on how you can help the project.

How to Contribute

Reporting Issues

If you find a bug or have a suggestion for improvement, please create an issue on GitHub. When creating an issue, please:

  1. Use a clear and descriptive title
  2. Provide a detailed description of the problem or suggestion
  3. Include steps to reproduce the issue (if applicable)
  4. Specify the expected behavior
  5. Add appropriate labels

Making Changes

  1. Fork the repository
  2. Create a new branch for your changes
  3. Make your changes
  4. Write tests for your changes
  5. Ensure all tests pass
  6. Submit a pull request

Code Review

A maintainer reviews your pull request before it merges, and the CI checks must pass; MAINTAINERS.md says how changes are reviewed. Please:

  1. Ensure your code follows the project's style
  2. Respond to reviewer comments
  3. Make necessary changes based on feedback

Documentation

Documentation improvements are also welcome! If you notice inaccuracies or have suggestions for improving the documentation, please:

  1. Create an issue describing the problem
  2. Submit a pull request with the proposed changes

Code Standards

  • Follow the project's code style
  • Write tests for new code
  • Update documentation as needed
  • Ensure your code passes all tests

License

By contributing, you agree that your contributions will be licensed under the Apache License 2.0.

Contact

If you have questions about contributing, please contact us through: