Skip to main content

Community Guidelines

Welcome to the Kexa community! These guidelines are designed to help maintain a positive and productive environment for all contributors.

Code of Conduct​

  1. Be Respectful: Treat all community members with respect and kindness.
  2. Be Inclusive: Welcome and support people of all backgrounds and identities.
  3. Be Collaborative: Work together to build the best possible tool for everyone.
  4. Be Constructive: Provide constructive feedback and suggestions.

Contributing Process​

1. Getting Started​

  • Fork the repository
  • Create a new branch for your feature/fix
  • Make your changes
  • Test your changes thoroughly
  • Submit a pull request

2. Pull Request Guidelines​

  • Use clear and descriptive commit messages
  • Reference any related issues in your PR
  • Include tests for new features
  • Update documentation as needed
  • Follow the existing code style

3. Code Style​

  • Follow the existing code formatting
  • Use meaningful variable and function names
  • Add comments for complex logic
  • Keep functions small and focused
  • Write unit tests for new features

4. Documentation​

  • Update README.md if needed
  • Add comments to complex code
  • Document new features
  • Update existing documentation

5. Testing​

  • Write unit tests for new features
  • Ensure all tests pass
  • Test edge cases
  • Include integration tests when appropriate

6. Review Process​

  • Be responsive to review comments
  • Address feedback promptly
  • Be open to suggestions
  • Help review others' code

Communication​

1. Issues​

  • Use the issue tracker for bug reports and feature requests
  • Provide detailed information when reporting bugs
  • Check existing issues before creating new ones
  • Use appropriate labels

2. Discussions​

  • Use the discussion forum for general questions
  • Share ideas and suggestions
  • Help others with their questions
  • Be patient with new contributors

3. Pull Requests​

  • Respond to review comments
  • Keep discussions focused and constructive
  • Be open to feedback
  • Help others with their PRs

Recognition​

  • Contributors will be recognized in the project's README
  • Significant contributions will be highlighted
  • All contributors are valued and appreciated

Getting Help​

  • Check the documentation first
  • Search existing issues and discussions
  • Ask in the discussion forum
  • Reach out to maintainers if needed

Reporting Problems​

  • Use the issue tracker
  • Provide detailed information
  • Include steps to reproduce
  • Share relevant logs and screenshots

Security​

  • Report security vulnerabilities privately
  • Follow responsible disclosure
  • Keep sensitive information private
  • Use secure coding practices

License​

By contributing to Kexa, you agree that your contributions will be licensed under the project's Apache License.

Questions?​

If you have any questions about these guidelines, please open a discussion or contact the maintainers.

Thank you for contributing to Kexa!