Commit 8f1a4c9e authored by Martin Lowe's avatar Martin Lowe 🇨🇦 Committed by Martin Lowe
Browse files

Update README with information on bots

parent 16a65865
......@@ -4,6 +4,15 @@ This project uses Quarkus, the Supersonic Subatomic Java Framework.
If you want to learn more about Quarkus, please visit its website: https://quarkus.io/ .
<!-- TOC -->
- [What is a valid commit?](#what-is-a-valid-commit)
- [Submitting applications for new bots](#submitting-applications-for-new-bots)
- [Running the application in dev mode](#running-the-application-in-dev-mode)
- [Packaging and running the application](#packaging-and-running-the-application)
- [Enabling commit hook in GitLab](#enabling-commit-hook-in-gitlab)
<!-- /TOC -->
## What is a valid commit?
To be considered a valid commit, the following set of rules are checked against all commits that are submitted to this service. If any fail and the commit is related to a project, the service returns a message indicating the commit is not suitable for submission along with messages as hints.
......@@ -22,6 +31,10 @@ example) Signed-off-by: Martin Lowe <martin.lowe@eclipse-foundation.org>
While these rules apply to all project repositories, any non-project repositories will also be checked. The messages indicate the failures as warnings to the consuming service (like Gitlab or Gerrit) unless 'strict mode' is enabled for the service. Whether or not a repository is tracked (or if it is a project repository) is determined by its presence as a repository directly linked to an active project within the [PMI](https://projects.eclipse.org/), as reported by the [Projects API](https://api.eclipse.org/#tag/Projects).
## Submitting applications for new bots
Does your project require a bot to mroe effectively run, or additional bots for new functionality? To submit requests for new bots to be registered within our API, please see the [Project Bots API repository](https://github.com/EclipseFdn/projects-bots-api) and create an issue. We will require the projects name, your Eclipse Foundation username (for verification of authority), the name of the bot, the email address used to register the account for the bot, and a quick description of what the bot will do so that we can properly document it internally.
## Running the application in dev mode
You can run your application in dev mode that enables live coding using:
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment