Skip to content

Latest commit

 

History

History
52 lines (36 loc) · 2.72 KB

CONTRIBUTING.md

File metadata and controls

52 lines (36 loc) · 2.72 KB

How to contribute to the Video Query project

This project comprises separate repositories for the front end, the API, and the Algorithms back end. If you know your issue is specific to one of these repositories, please address it from there:

Did you find a bug?

Do you have questions about the source code?

  • Ask any question about how to use Video Query in the Issues.

Do you intend to add a new feature or change an existing one?

  • Suggest your change as an Issue in the specific repository where it would be added.
  • It is best you don't start any development until the change has been reviewed by the team and approved first.

Did you write a patch that fixes a bug?

  • Open a new GitHub pull request with the patch.
  • Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.

Are you ready to submit a PR?

Please send a GitHub Pull Request in the appropriate repository (Client, API, or Algorithms) with a clear list of what you've done (read more about pull requests). Please make sure all of your commits are atomic (one feature per commit).

Always write a clear log message for your commits. One-line messages are fine for small changes, but bigger changes should look like this:

$ git commit -m "A brief summary of the commit
>
> A paragraph describing what changed and its impact."