We appreciate your contribution to this amazing project! Any form of engagement is welcome, including but not limiting to

• feature request
• documentation wording
• bug report
• roadmap suggestion
• ...and so on!

Please refer to the community contributing section for more details.

Before delving into the details to come up with your first PR, please familiarise yourself with the project structure of Instill Core.

• Instill Model

check out .pre-commit-config.yaml for the set of hooks that we used

On the local machine, clone model repository in your workspace, move to the repository folder, and launch all dependent microservices:

$ cd <your-workspace>
$ git clone https://github.com/instill-ai/model.git
$ cd model
$ make latest PROFILE=controller

Clone controller-model repository in your workspace and move to the repository folder:

$ cd <your-workspace>
$ git clone https://github.com/instill-ai/controller-model.git
$ cd controller-model

$ make build

$ make dev

Now, you have the Go project set up in the container, in which you can compile and run the binaries together with the integration test in each container shell.

$ docker exec -it controller-model /bin/bash
$ go run ./cmd/main

$ docker exec -it controller-model /bin/bash
$ make integration-test

$ make stop

go test -race ./... -covermode=atomic

The latest images will be published to Docker Hub repository at release.

Please take these general guidelines into consideration when you are sending a PR:

1. Fork the Repository: Begin by forking the repository to your GitHub account.
2. Create a New Branch: Create a new branch to house your work. Use a clear and descriptive name, like <your-github-username>/<what-your-pr-about>.
3. Make and Commit Changes: Implement your changes and commit them. We encourage you to follow these best practices for commits to ensure an efficient review process:
   • Adhere to the conventional commits guidelines for meaningful commit messages.
   • Follow the 7 rules of commit messages for well-structured and informative commits.
   • Rearrange commits to squash trivial changes together, if possible. Utilize git rebase for this purpose.
4. Push to Your Branch: Push your branch to your GitHub repository: git push origin feat/<your-feature-name>.
5. Open a Pull Request: Initiate a pull request to our repository. Our team will review your changes and collaborate with you on any necessary refinements.

When you are ready to send a PR, we recommend you to first open a draft one. This will trigger a bunch of tests workflows running a thorough test suite on multiple platforms. After the tests are done and passed, you can now mark the PR open to notify the codebase owners to review. We appreciate your endeavour to pass the integration test for your PR to make sure the sanity with respect to the entire scope of Instill Core.

Your contributions make a difference. Let's build something amazing together!