question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Validate artipie's repositories readme files content

See original GitHub issue

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:

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

Issue Analytics

  • State:closed
  • Created a year ago
  • Comments:8 (6 by maintainers)

github_iconTop GitHub Comments

3reactions
ChGencommented, Jun 22, 2022

what do you think of using badge for Telegram group reference? Join our Telegramm group 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)

1reaction
Swizbizcommented, Jun 23, 2022

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/

Read more comments on GitHub >

github_iconTop Results From Across the Web

Artipie roadmap - GitHub
Validate artipie's repositories readme files content ... Swizbiz. Feature Request: Support Hex repositories (Erlang / Elixir packages). front #91.
Read more >
How can I test what my readme.md file will look like before ...
Preview a GitHub README.md. Either: - Copy this file to a directory that contains repo directories, and then specify a repo name in...
Read more >
README File – Everything you Need to Know - Great Learning
A README file is a text file that describes and launches a project. It comprises information that is frequently needed to grasp the...
Read more >
How to Write a Good README File for Your GitHub Project
In this article, we'll learn more about what a README file is and how to write one. First let's understand what we mean...
Read more >
Share information with a project, repo, README, or Wiki
You can use Markdown format within a team project Wiki, content you add to a dashboard, your team project README file, or other...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found