Skip to content

Latest commit

 

History

History
58 lines (42 loc) · 3.5 KB

CONTRIBUTING.md

File metadata and controls

58 lines (42 loc) · 3.5 KB
Raw

Contributing Guidelines

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.

Development and codebase contribution

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

Sending PRs

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:
  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.

How to contribute to the console

Local development environment setup

  • instill-ai/core
  • instill-ai/vdp
    • Go to instill-ai/vdp and clone it.
    • Spin up the services by make latest PROFILE=all
  • instill-ai/model (if you are developing model related pages)

Spin up the console

  • Go to instill-ai/console and clone it
  • Go to the root of the project and run pnpm install and then run pnpm build
  • Go to the packages/toolkit and run pnpm dev, keep this terminal running
  • Open another terminal then go to the packages/toolkit and run pnpm dev-ts, keep this terminal running
  • Go to the apps/console, and run pnpm dev, keep this terminal running
  • You are all set, go to http://localhost:3000 to see the console
  • The default login password is: password

Last words

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