Skip to content

Latest commit

 

History

History
89 lines (60 loc) · 3.14 KB

CONTRIBUTING.md

File metadata and controls

89 lines (60 loc) · 3.14 KB

Contributing to Inferable

First off, thank you for considering contributing to Inferable! We value every contribution that helps make this project better.

Welcome!

We accept contributions in various forms, from bug fixes and documentation improvements to major feature additions. While we welcome most contributions, please note that not all submissions may be accepted. Our team will review each contribution carefully to ensure it aligns with the project's goals and standards.

Getting Started

  1. Fork the repository
  2. Create a new branch for your feature (git checkout -b feature/amazing-feature)
  3. Make your changes
  4. Run the appropriate tests for your changes
  5. Commit your changes (git commit -m 'Add some amazing feature')
  6. Push to the branch (git push origin feature/amazing-feature)
  7. Open a Pull Request

Development Setup

Since Inferable is a polyglot repository containing multiple programming languages, you'll need to set up the appropriate development environment for the specific component you're working on. Please refer to the README in each specific directory for detailed setup instructions.

Code Style

We maintain different code style guidelines for each programming language in the repository. Please follow the conventions.

Testing

  • Write tests for any new features or bug fixes
  • Ensure all tests pass before submitting your PR
  • Include both unit tests and integration tests where appropriate
  • Follow the testing conventions established in each language-specific directory

Pull Request Process

  1. Update the README.md with details of significant changes if applicable
  2. Update the documentation for any changed functionality
  3. Ensure your code passes all tests and linting requirements
  4. Add your changes to the CHANGELOG.md under the "Unreleased" section
  5. The PR must be reviewed and approved by at least one maintainer
  6. If you modify multiple languages/components, seek review from respective component owners

Commit Messages

  • Use clear and meaningful commit messages
  • Start with a verb in the present tense (e.g., "Add", "Fix", "Update")
  • Reference any relevant issues or PRs in the message

Example:

Fix: Resolve memory leak in function pre-processor (#123)

What We're Looking For

  • Bug fixes
  • Documentation improvements
  • Performance optimizations
  • New features aligned with the project's goals
  • Test coverage improvements
  • Code quality enhancements

What We're Not Looking For

  • Breaking changes without prior discussion
  • Features that significantly deviate from the project's scope
  • Changes that don't follow our coding standards
  • Undocumented or untested code

Communication

  • Use GitHub Issues for bug reports and feature requests
  • Use Pull Requests for code contributions
  • Be respectful and constructive in all communications
  • Tag relevant maintainers when needed

Questions?

If you have questions about contributing, feel free to:

  • Open an issue with your question
  • Ask in the relevant Pull Request

License

By contributing to Inferable, you agree that your contributions will be licensed under the same license as the project.

Thank you for contributing to Inferable!