You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Thank you for your interest in contributing to [InferaDB](https://inferadb.com)! We welcome contributions from the community and are grateful for any help you can provide.
3
+
We welcome contributions! By participating, you agree to uphold the [Code of Conduct](CODE_OF_CONDUCT.md).
4
4
5
-
## Code of Conduct
5
+
## Reporting Issues
6
6
7
-
This project and everyone participating in it is governed by the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [open@inferadb.com](mailto:open@inferadb.com).
7
+
-**Bugs**: Search existing issues first. Include version, steps to reproduce, expected vs actual behavior.
8
+
-**Features**: Describe the use case and proposed solution.
9
+
-**Security**: Email [security@inferadb.com](mailto:security@inferadb.com) — do not open public issues.
8
10
9
-
## How to Contribute
11
+
## Pull Requests
10
12
11
-
### Reporting Issues
13
+
1. Fork and branch from `main`
14
+
2. Run `just ci` to verify tests, linting, and formatting pass
15
+
3. Follow [Conventional Commits](https://www.conventionalcommits.org/) for commit messages
16
+
4. Update documentation if changing public APIs
17
+
5. Submit PR with clear description
12
18
13
-
-**Bug Reports**: Search existing issues first to avoid duplicates. Include version information, steps to reproduce, expected vs actual behavior, and relevant logs.
14
-
-**Feature Requests**: Describe the use case, proposed solution, and alternatives considered.
15
-
-**Security Issues**: Do **not** open public issues for security vulnerabilities. Instead, email [security@inferadb.com](mailto:security@inferadb.com).
19
+
## Development
16
20
17
-
### Pull Requests
21
+
```bash
22
+
mise trust && mise install # Setup tooling
23
+
just ci # Run all checks before submitting
24
+
```
18
25
19
-
1.**Fork the repository** and create your branch from `main`
20
-
2.**Follow the development workflow** documented in the repository's [README.md](README.md)
21
-
3.**Write clear commit messages** following [Conventional Commits](https://www.conventionalcommits.org/)
22
-
4.**Ensure all tests pass** before submitting
23
-
5.**Update documentation** if your changes affect public APIs or user-facing behavior
24
-
6.**Submit a pull request** with a clear description of your changes
25
-
26
-
### Development Setup
27
-
28
-
Each repository has its own development setup and workflow. See the repository's [README.md](README.md) for prerequisites, build commands, and development workflow.
26
+
See [README.md](README.md) for full development setup.
29
27
30
28
## Review Process
31
29
32
-
1.**Automated Checks**: CI will run tests, linters, and formatters
33
-
2.**Peer Review**: At least one maintainer will review your contribution
34
-
3.**Feedback**: Address any review comments
35
-
4.**Approval**: Once approved, a maintainer will merge your contribution
30
+
1. CI runs automated checks
31
+
2.Maintainer reviews code
32
+
3. Address feedback
33
+
4.Maintainer merges on approval
36
34
37
35
## License
38
36
39
-
By contributing to [InferaDB](https://github.com/inferadb), you agree that your contributions will be dual-licensed under:
40
-
41
-
-[Apache License, Version 2.0](LICENSE-APACHE)
42
-
-[MIT License](LICENSE-MIT)
37
+
Contributions are dual-licensed under [MIT](LICENSE-MIT) and [Apache 2.0](LICENSE-APACHE).
43
38
44
39
## Questions?
45
40
46
-
If you have questions or need help:
47
-
48
-
- Join our [Discord server](https://discord.gg/inferadb) to chat with the community
49
-
- Email us at [open@inferadb.com](mailto:open@inferadb.com)
0 commit comments