Skip to content

Latest commit

 

History

History
108 lines (80 loc) · 2.55 KB

CONTRIBUTING.md

File metadata and controls

108 lines (80 loc) · 2.55 KB

Contributing to Nexlog

First off, thank you for considering contributing to Nexlog! It's people like you that make Nexlog such a great tool.

Ways to Contribute

There are many ways to contribute to Nexlog:

  • Reporting bugs
  • Suggesting enhancements
  • Writing documentation
  • Improving error messages
  • Submitting code changes
  • Helping others use Nexlog

Development Process

  1. Fork the Project
  2. Create your Feature Branch 
    git checkout -b feature/AmazingFeature
  3. Make your Changes
    • Write clear, concise commit messages
    • Add tests for new functionality
    • Update documentation as needed
  4. Run Tests 
    zig build test
  5. Submit a Pull Request

Code Style Guidelines

  • Follow the Zig style guide
  • Use meaningful variable and function names
  • Keep functions focused and small
  • Add comments for complex logic
  • Include error handling

Pull Request Process

  1. Before Submitting

    • Update the README.md with details of changes if needed
    • Add tests for new functionality
    • Ensure all tests pass
    • Update documentation

  2. PR Description

    • Describe the changes you've made
    • Link any relevant issues
    • Include screenshots for UI changes
    • List any new dependencies

  3. Review Process

    • A maintainer will review your PR
    • Address any requested changes
    • Once approved, your PR will be merged

Reporting Bugs

When filing an issue, please include:

  • Your Zig version (zig version)
  • Operating system and version
  • Steps to reproduce the issue
  • Expected behavior
  • Actual behavior
  • Code samples if applicable
  • Error messages and logs

Feature Requests

Feature requests are welcome! Please provide:

  • Clear description of the feature
  • Use cases
  • Possible implementation approach
  • Why this feature would be useful to other users

Documentation

  • Keep language simple and clear
  • Include code examples where helpful
  • Update relevant documentation for any changes
  • Check spelling and grammar

Community Guidelines

  • Be respectful and inclusive
  • Welcome newcomers
  • Stay on topic
  • Help others learn

Questions?

  • Join our discussions on GitHub
  • Check existing issues and pull requests
  • Open a new issue for general questions

License

By contributing to Nexlog, you agree that your contributions will be licensed under its MIT License.

Remember: The best way to start contributing is to begin with small improvements. Even fixing a typo helps!

Thank you for your contribution! 🚀