From c49bced129343b33d4d14e1a701b8830d994877e Mon Sep 17 00:00:00 2001 From: Milana Kerbel Date: Fri, 1 Dec 2023 12:45:20 +0200 Subject: [PATCH] contribution update --- CONTRIBUTING.md | 65 ++++++++----------------------------------------- 1 file changed, 10 insertions(+), 55 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cedeef6..e26f504 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,63 +1,18 @@ -# Contributing to ai-collection +# Contributing to AI Collection -## Contribution are more than welcome! +## Contribution are made through the self service flow only --- -## Formatting +## To Contribute: -Current AI project format: +To contribute, simply submit your application to https://www.thataicollection.com/submit and once approved, it will +automatically be translated and synced with this repo in the FULL_README files and "recently added" on main README.md file. -| 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 | +After submission, checkout your application owners page for details on how to secure placement on the main README.md file. -
+I am available on pavel@ai-collection.org or on X/Twitter for any question or feedback. -Example project: - -``` -| [Equally.ai](https://equally.ai/) | Web Accessibility Compliance For All | Achieve ADA & WCAG compliance easily | :white_check_mark: | -``` - -> Note: if you see links with this prefix: `https://www.thataicollection.com/redirect/`, it means that this application is listed on our website and we use redirect to be able to count amount of clicks to this application from AI Collection. - -## To Contribute Using the New Submission Flow - -The new and preferred way to contribute is simply to submit your application to https://www.thataicollection.com/submit and once approved, it will -automatically be synced with this repo. - -## To Contribute using a PR to GitHub - -If you still prefer to create a PR, these are the old guidelines, but please make sure you submit also to https://www.thataicollection.com/submit so your application will not be lost in future syncs with the website. - - -Created a branch on your fork with your changes, and [make a pull request][pr-link]. - -## Pull Request Guidelines - -* 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) -* Each table column should be padded with one space on either side. -* The Title should not exceed 120 characters and should not contain the character `|`. -* The Title will be re-formatted automatically to keep the standard of New York Times Manual of Style. -* 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: - * :white_check_mark: - `:white_check_mark:` - * :grey_question: - `:grey_question:` - * :x: - `:x:` -* 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. -* Target your Pull Request to the `main` branch of the `ai-collection` -* Translations are auto-generated, so no need to add/update in multiple README files. -* If you are the creator of this awesome AI application, feel free to add your twitter handle in the PR comment. We will mention you. - -Once pull request is created, collaborators will review the proposed change and decide whether or not to pull in your changes. - -Thanks for reading this. -Please consider staring this repo and following us on [twitter](https://twitter.com/ai_collection_) - -[pr-link]: +Please consider staring this repo and following me on X/Twitter: +- [AI Collection](https://twitter.com/ai_collection_) +- [@kerbelp](https://twitter.com/kerbelp)