2023-01-10 01:18:48 -05:00
|
|
|
# Contributing to ai-collection
|
|
|
|
|
|
|
|
|
|
## Contribution are more than welcome!
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
## Formatting
|
|
|
|
|
|
|
|
|
|
Current AI project format:
|
|
|
|
|
|
|
|
|
|
| Name | Title | Description | Offer Free Version |
|
|
|
|
|
| --- | --- | --- | --- |
|
|
|
|
|
| AI project Name(Link to website) | Project's title | Project's description | Does the project offer a free usage version |
|
|
|
|
|
|
|
|
|
|
<br />
|
|
|
|
|
|
|
|
|
|
Example project:
|
|
|
|
|
|
|
|
|
|
```
|
2023-02-01 00:27:50 -05:00
|
|
|
| [Equally.ai](https://equally.ai/) | Web Accessibility Compliance For All | Achieve ADA & WCAG compliance easily | :white_check_mark: |
|
2023-01-10 01:18:48 -05:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## To Contribute
|
|
|
|
|
|
2023-02-01 00:27:50 -05:00
|
|
|
Created a branch on your fork with your changes, and [make a pull request][pr-link].
|
2023-01-10 01:18:48 -05:00
|
|
|
|
|
|
|
|
## Pull Request Guidelines
|
|
|
|
|
|
2023-02-18 00:57:54 -05:00
|
|
|
* Verify that the AI application is not already listed
|
|
|
|
|
* Always add the new application to the end of the category table (it will sorted alphabetically during next job run)
|
2023-01-10 01:18:48 -05:00
|
|
|
* Each table column should be padded with one space on either side.
|
2023-01-31 23:57:28 -05:00
|
|
|
* The Title should not exceed 120 characters and should not contain the character `|`.
|
2023-02-05 08:05:21 -05:00
|
|
|
* The Title will be re-formatted automatically to keep the standard of New York Times Manual of Style.
|
2023-01-10 01:18:48 -05:00
|
|
|
* The Description should not exceed 300 characters and should not contain the character `|`.
|
|
|
|
|
* The `Offer Free Version` column should have one of these three values:
|
2023-01-10 02:07:27 -05:00
|
|
|
* :white_check_mark: - `:white_check_mark:`
|
2023-01-10 01:18:48 -05:00
|
|
|
* :grey_question: - `:grey_question:`
|
|
|
|
|
* :x: - `:x:`
|
2023-02-18 00:57:54 -05:00
|
|
|
* Add one AI application per Pull Request.
|
|
|
|
|
* For new additions, make sure the PR title is in the format of `Add name` *for e.g.*: `Add Equally.ai`
|
|
|
|
|
* For updates, make sure the PR title is in the format of `Update name` *for e.g.*: `Update Equally.ai`
|
|
|
|
|
* Use a short descriptive commit message. *for example*: `Add Equally.ai`
|
|
|
|
|
* Please make sure the AI application has a title and description.
|
2023-01-10 01:18:48 -05:00
|
|
|
* Target your Pull Request to the `main` branch of the `ai-collection`
|
2023-02-18 00:57:54 -05:00
|
|
|
* Translations are auto-generated, so no need to add/update in multiple README files.
|
2023-01-10 01:18:48 -05:00
|
|
|
|
|
|
|
|
Once pull request is created, collaborators will review the proposed change and decide whether or not to pull in your changes.
|
|
|
|
|
|
|
|
|
|
[pr-link]: <https://help.github.com/articles/creating-a-pull-request/>
|
