Skip to content

Latest commit

 

History

History
69 lines (50 loc) · 1.84 KB

CONTRIBUTING.md

File metadata and controls

69 lines (50 loc) · 1.84 KB

Contributing to Nyx

Thank you for your interest in contributing to Nyx! This document provides guidelines and steps for contributing to the project.

Getting Started

  1. Fork the repository
  2. Clone your fork: 
    git clone https://github.com/your-username/nyx.git
  3. Add the upstream remote: 
    git remote add upstream https://github.com/nyx-lang/nyx.git

Development Workflow

  1. Create a new branch for your feature/fix: 
    git checkout -b feature-name
  2. Make your changes
  3. Write or update tests as needed
  4. Ensure all tests pass
  5. Commit your changes following our commit message guidelines

Code Style Guidelines

  • Follow the project's coding conventions
  • Write clear, documented, and maintainable code
  • Include comments where necessary
  • Write meaningful variable and function names
  • Keep functions focused and concise

Pull Request Process

  1. Update documentation if needed
  2. Ensure your PR includes only one feature/fix
  3. Link any related issues
  4. Update the README if necessary
  5. Wait for code review and address any feedback

Reporting Issues

  • Use the GitHub issue tracker
  • Check existing issues before creating new ones
  • Include clear steps to reproduce bugs
  • Provide system/environment details
  • Use issue templates when available

Testing

  • Write unit tests for new features
  • Ensure all tests pass before submitting PRs
  • Update existing tests when changing functionality

License

This project is licensed under the Apache 2.0 License - see the LICENSE file for details.

Questions or Need Help?

Code of Conduct

Please note that this project follows our Code of Conduct. By participating, you agree to uphold this code.