Validate artipie's repositories readme files content

dgarus commented 2 years ago

Repository - adapter:

check header (should be as maven-adapter has)
link to roadmap
link to telegram chat: https://t.me/artipie
maven dependency (if adapter has)
description of repository structure and link to the repository documentation the implementation is based on
description of SDK and examples how to use
description how to configure a client to use the repository
how to contribute section is exist and contains Please read [contributing rules](https://github.com/artipie/artipie/blob/master/CONTRIBUTING.md)
add action for update license year

Artipie:

check header (should be as maven-adapter has)
link to telegram chat: https://t.me/artipie
link to roadmap
check wiki content
how start
check all links
how to contribute section is exist and contains Please read [contributing rules](https://github.com/artipie/artipie/blob/master/CONTRIBUTING.md)
add action for update license year

code examples for copy-paste is here

Repositories:

[x] artipie
- [x] main config
- [x] repos
- [x] repo perms
- [x] creds
- [x] storages
- [x] metrix
[x] asto (+)
[x] front (+)
[x] conan-adapter (+)
[x] http (+)
[x] rpm-adapter (Alena) (+)
[x] npm-adapter (Alena) (+)
[x] gem-adapter (Denis) (+)
[x] git-adapter
[x] p2-adapter
[x] go-adapter
[x] files-adapter (Denis) (+)
[x] docker-adapter (Denis) (+)
[x] helm-adapter (Denis)
[x] pypi-adapter (pypi-example) (+)
[x] maven-adapter (+)
[x] http-client (+)
[x] vertx-server (+)
[x] nuget-adapter
[x] conda-adapter (+)
[x] cargo-adapter
[x] debian-adapter (+)
[x] composer-adapter (Denis)
[x] benchmarks

Swizbiz commented 2 years ago

@artipie/members I think we should add this phrase to How to contribute

Please read contributing rules.

Swizbiz commented 2 years ago

@artipie/members I think we also have to bump year in license header to 2022

dgarus commented 2 years ago

@artipie/members I think we also have to bump year in license header to 2022

We should do it easier, automatically. @Swizbiz could you please create an issue for this subject?

Swizbiz commented 2 years ago

@artipie/members I think we also have to bump year in license header to 2022

We should do it easier, automatically. @Swizbiz could you please create an issue for this subject?

Created issue https://github.com/artipie/artipie/issues/1035

ChGen commented 2 years ago

what do you think of using badge for Telegram group reference? README.md code: [![Join our Telegramm group](https://img.shields.io/badge/Join%20us-Telegram-blue?&logo=telegram&?link=http://right&link=http://t.me/artipie)](http://t.me/artipie)

Swizbiz commented 2 years ago

README header example:

<a href="http://artipie.com"><img src="https://www.artipie.com/logo.svg" width="64px" height="64px"/></a>

[![Join our Telegramm group](https://img.shields.io/badge/Join%20us-Telegram-blue?&logo=telegram&?link=http://right&link=http://t.me/artipie)](http://t.me/artipie)

[![EO principles respected here](https://www.elegantobjects.org/badge.svg)](https://www.elegantobjects.org)
[![DevOps By Rultor.com](http://www.rultor.com/b/artipie/http-client)](http://www.rultor.com/p/artipie/http)
[![We recommend IntelliJ IDEA](https://www.elegantobjects.org/intellij-idea.svg)](https://www.jetbrains.com/idea/)

[![Javadoc](http://www.javadoc.io/badge/com.artipie/http-client.svg)](http://www.javadoc.io/doc/com.artipie/http-client)
[![License](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/artipie/http-client/blob/master/LICENSE.txt)
[![codecov](https://codecov.io/gh/artipie/http-client/branch/master/graph/badge.svg)](https://codecov.io/gh/artipie/http-client)
[![Hits-of-Code](https://hitsofcode.com/github/artipie/http-client)](https://hitsofcode.com/view/github/artipie/http-client)
[![Maven Central](https://img.shields.io/maven-central/v/com.artipie/http-client.svg)](https://maven-badges.herokuapp.com/maven-central/com.artipie/http-client)
[![PDD status](http://www.0pdd.com/svg?name=artipie/http-client)](http://www.0pdd.com/p?name=artipie/http-client)

Phrase about Telegram channel and roadmap:

If you have any question or suggestions, do not hesitate to [create an issue](https://github.com/artipie/http-client/issues/new) or contact us in
[Telegram](https://t.me/artipie).  
Artipie [roadmap](https://github.com/orgs/artipie/projects/3).

Warning don't forget change http-client to your repository name

Phrase for How to contribute:

Please read [contributing rules](https://github.com/artipie/artipie/blob/master/CONTRIBUTING.md).

Action for update license year

add this yml file in folder - .github/workflows/

0pdd commented 2 years ago

@dgarus the puzzle #1083 is still not solved.

0pdd commented 1 year ago

@dgarus the only puzzle #1083 is solved here.

artipie / artipie