프로토타입 · 미리 보기: 공식 레지스트리의 모든 서버를 담고 있으며 30분마다 동기화해요. Google로 로그인하면 리뷰를 쓸 수 있어요.프로토타입 · 30분마다 업데이트
PopNx MCPAI를 쓰는 사람을 위한 MCP 서버 · 쉬운 말로 설명해요 로그인

LowEndInsight

제작자: kitplummer버전 0.16.0-beta.3i★ 1 (저장소 전체의 별)i클라우드에서 실행공식 사이트 ↗
레지스트리 이름io.github.kitplummer/lowendinsight

설치 방법

할 수 있는 일

Is a dependency still maintained now? Contributors, recency of real work, risk.

제작자가 쓴 원문

  • 연결 방식 클라우드에서 실행
  • 계정 또는 키 Authorization 필요
  • 분류 기타

이 순위인 이유

목록은 사용 점수(100점 만점)로 정렬되며 구성은 다음과 같습니다

인기0/80GitHub 별 또는 주간 다운로드: 큰 쪽 60, 작은 쪽 20
최신성12/1230일 안에 릴리스나 코드 변경이 있으면 만점
응답 중8/8마지막 점검 때 클라우드 엔드포인트가 응답
사용 점수20/100

품질: 기본 점검 5/5개 통과(표시만, 정렬에는 안 씀) · 상승세: 데이터 없음 (급상승 탭에서만 사용)

설치

쓰고 있는 AI 앱을 고른 다음 설정을 복사하세요.

한 문장으로 AI에게 설치 맡기기

LowEndInsight 설치해 줘. https://mcp.popnx.com/i/kitplummer-lowendinsight.md 를 따라 하고, 명령을 먼저 보여 주고 내가 승인하면 실행해.

내 컴퓨터에서 작업하는 AI(Claude Code, Cursor 등)에 붙여 넣으세요. 단계를 읽고 명령을 보여 준 뒤 승인을 기다립니다. 키도 가입도 필요 없습니다. · AI가 읽을 전체 내용 보기

검사 5/5 통과 · 내가 묻는 내용은 제작자 서버(lowendinsight.dev)를 거쳐요 · ✓ 명령 확인 2026년 11월 20일

먼저: 어떤 AI를 쓰시나요?

쓰는 앱을 고르면 아래에 단계가 나옵니다.

Claude에 연결할 수 있어요 · 약 5분

LowEndInsight 키가 필요해요 (제작자 사이트에서 만들기) · claude.ai나 데스크톱 앱에서 한 번 설정하면 채팅에서 쓸 수 있어요 · 무료 계정은 1개까지 · Team/Enterprise는 소유자(Owner)가 추가

  1. LowEndInsight에 가입하고 키 만들기

    제작자 사이트에서 가입하고 다음 단계에 쓸 API 키를 만드세요. 요금과 무료 요금제는 제작자 사이트에서 확인하세요.

    LowEndInsight 사이트 열기 ↗

  2. Claude의 Connectors 페이지 열기

    CustomizeConnectors

    CustomizeConnectors1Add2https://…3Add4
  3. “Add” → “Custom” → “Web”를 누르고 이 2칸 채우기

    여기서 복사해 Claude의 같은 이름 칸에 붙여 넣고 Continue를 누르세요

    Name · 이름LowEndInsight
    Remote MCP server URL · 주소https://lowendinsight.dev/mcp

    Request headers에 이 이름과 값을 추가

    헤더 이름Authorization
    값Bearer <여기에 키 붙여 넣기>

    키는 앱 입력란에만 붙여 넣고, 채팅에 붙이거나 다른 사람에게 보내지 마세요

    Claude가 찾은 로그인 설정 화면에서 Continue를 누르고 · Authentication은 제작자 안내대로(Sign in now, Sign in when needed, No sign in) 고른 뒤 Add를 누르세요

  4. 채팅에서 켜기

    +ConnectorsLowEndInsight

  5. 해 보기

    LowEndInsight을 써서 나에게 무엇을 해 줄 수 있는지 알려 주고, 하나 해 봐

    ✓ Claude가 LowEndInsight을 쓰고 있다고 하거나 답에 LowEndInsight 도구 이름이 나오면 연결된 거예요

메뉴 이름은 2026년 11월 11일에 Anthropic 도움말에서 확인 · 앱 버전에 따라 화면이 조금 다를 수 있어요

ChatGPT는 아직 LowEndInsight에 연결할 수 없어요

LowEndInsight는 연결할 때 내 키가 필요한데, OpenAI 도움말은 OAuth 로그인만 설명하고 우리가 확인한 키 입력 방법이 없어요

대신 이렇게 할 수 있어요

A · LowEndInsight에 연결되는 앱 쓰기

  • LowEndInsight 키가 필요해요 (제작자 사이트에서 만들기) · claude.ai나 데스크톱 앱에서 한 번 설정하면 채팅에서 쓸 수 있어요 · 무료 계정은 1개까지 · Team/Enterprise는 소유자(Owner)가 추가
  • LowEndInsight 키가 필요해요 (제작자 사이트에서 만들기)
  • LowEndInsight 키가 필요해요 (제작자 사이트에서 만들기)
  • LowEndInsight 키가 필요해요 (제작자 사이트에서 만들기)

B · 기타에서 ChatGPT에 연결되는 다른 서버

같은 분류에서 많이 쓰는 것 중 키 없이 주소만으로 연결되는 것을 골랐어요

Claude Code에 연결할 수 있어요 · 약 5분

LowEndInsight 키가 필요해요 (제작자 사이트에서 만들기)

  1. LowEndInsight에 가입하고 키 만들기

    제작자 사이트에서 가입하고 다음 단계에 쓸 API 키를 만드세요. 요금과 무료 요금제는 제작자 사이트에서 확인하세요.

    LowEndInsight 사이트 열기 ↗

  2. 터미널 열기

    Mac: Command+스페이스를 누르고 Terminal 입력 · Windows: PowerShell 열기

  3. 이 명령을 붙여 넣고 Enter

    claude mcp add --transport http --scope user lowendinsight https://lowendinsight.dev/mcp --header 'Authorization: Bearer your-value'

    Enter 전에 “your-value”를 내 키로 바꾸세요

    키는 앱 입력란에만 붙여 넣고, 채팅에 붙이거나 다른 사람에게 보내지 마세요

  4. Claude Code에서 /mcp 입력

    LowEndInsight이 목록에 있고 연결됨으로 보이면 돼요

  5. 해 보기

    LowEndInsight을 써서 나에게 무엇을 해 줄 수 있는지 알려 주고, 하나 해 봐

    ✓ Claude Code가 LowEndInsight을 쓰고 있다고 하거나 답에 LowEndInsight 도구 이름이 나오면 연결된 거예요

메뉴 이름은 2026년 11월 11일에 Anthropic 도움말에서 확인 · 앱 버전에 따라 화면이 조금 다를 수 있어요

Cursor에 연결할 수 있어요 · 약 5분

LowEndInsight 키가 필요해요 (제작자 사이트에서 만들기)

  1. LowEndInsight에 가입하고 키 만들기

    제작자 사이트에서 가입하고 다음 단계에 쓸 API 키를 만드세요. 요금과 무료 요금제는 제작자 사이트에서 확인하세요.

    LowEndInsight 사이트 열기 ↗

  2. 이 버튼으로 Cursor 열기

    Cursor에서 열기

    Cursor가 설치를 확인하면 Install을 누르세요

  3. 키 입력

    LowEndInsight 설정에서 Authorization가 비어 있어요. 내 키를 넣고 저장하세요

    키는 앱 입력란에만 붙여 넣고, 채팅에 붙이거나 다른 사람에게 보내지 마세요

  4. Cursor에서 AI 채팅을 Agent 모드로 열기

  5. 해 보기

    LowEndInsight을 써서 나에게 무엇을 해 줄 수 있는지 알려 주고, 하나 해 봐

    ✓ Cursor가 LowEndInsight을 쓰고 있다고 하거나 답에 LowEndInsight 도구 이름이 나오면 연결된 거예요

메뉴 이름은 2026년 11월 11일에 Cursor 도움말에서 확인 · 앱 버전에 따라 화면이 조금 다를 수 있어요

VS Code에 연결할 수 있어요 · 약 5분

LowEndInsight 키가 필요해요 (제작자 사이트에서 만들기)

  1. LowEndInsight에 가입하고 키 만들기

    제작자 사이트에서 가입하고 다음 단계에 쓸 API 키를 만드세요. 요금과 무료 요금제는 제작자 사이트에서 확인하세요.

    LowEndInsight 사이트 열기 ↗

  2. 이 버튼으로 VS Code 열기

    VS Code에서 열기

    VS Code가 설치를 확인하면 Install을 누르세요

  3. 키 입력

    LowEndInsight 설정에서 Authorization가 비어 있어요. 내 키를 넣고 저장하세요

    키는 앱 입력란에만 붙여 넣고, 채팅에 붙이거나 다른 사람에게 보내지 마세요

  4. VS Code에서 AI 채팅을 Agent 모드로 열기

  5. 해 보기

    LowEndInsight을 써서 나에게 무엇을 해 줄 수 있는지 알려 주고, 하나 해 봐

    ✓ VS Code가 LowEndInsight을 쓰고 있다고 하거나 답에 LowEndInsight 도구 이름이 나오면 연결된 거예요

메뉴 이름은 2026년 11월 11일에 VS Code 도움말에서 확인 · 앱 버전에 따라 화면이 조금 다를 수 있어요

Windsurf, Zed, Gemini CLI 같은 다른 MCP 앱은 추가 방법이 저마다 달라요. 앱 목록에서 확인하세요

MCP를 쓰는 앱 모두 보기 →

웹으로 연결하는 앱용 주소

주소https://lowendinsight.dev/mcp

JSON 설정은 아래 “개발자용”에 있어요

막혔나요? LowEndInsight을 쓰는 사람에게 물어보세요💬 토론 →
개발자용: 터미널 명령과 JSON 설정

웹으로 연결

Claude Code

claude mcp add --transport http --scope user lowendinsight https://lowendinsight.dev/mcp --header 'Authorization: Bearer your-value'

Cursor (~/.cursor/mcp.json)

{
  "mcpServers": {
    "lowendinsight": {
      "url": "https://lowendinsight.dev/mcp",
      "headers": {
        "Authorization": "Bearer your-value"
      }
    }
  }
}

VS Code (mcp.json)

{
  "servers": {
    "lowendinsight": {
      "type": "http",
      "url": "https://lowendinsight.dev/mcp",
      "headers": {
        "Authorization": "Bearer your-value"
      }
    }
  }
}

직접 입력할 값

  • Authorization 비밀 HTTP header
    도구를 호출할 때 필요함. 연결 및 도구 목록 조회에는 키가 필요 없음. Bearer 뒤에 lei_로 시작하는 API 키를 입력. 베타 기간 중 무료: https://lowendinsight.dev/signup
    영어 원문 보기Needed to call the tools; connecting and listing them need none. Bearer followed by a lei_ API key. Free during the beta: https://lowendinsight.dev/signup

설명은 자동 번역이며 변수 이름은 원문 그대로입니다. 확실하지 않으면 원문을 확인하세요.

이 설정은 제작자의 레지스트리 정보로 만들었어요. README와 다르면 README를 따르세요.

한눈에 보기

GitHub 스타i
1 (저장소 전체의 별)
이 저장소에는 MCP 항목이 여러 개 있어 별은 순위에서 한 번만 세요
주간 다운로드i
npm/PyPI에 없음
라이선스i
BSD-3-Clause
연결 방식
클라우드에서 실행
전송 방식
streamable-http
최신 버전i
0.16.0-beta.3
카테고리i
기타
레지스트리 공개i
2026년 11월 20일
코드 마지막 변경i
2026년 11월 19일
마지막 확인
2026년 11월 19일
제작자
kitplummer
웹사이트
lowendinsight.dev
레지스트리 상태
활성

어떤 앱에서 쓸 수 있나요

이 서버의 연결 방식과 각 앱의 공식 문서를 바탕으로 했어요. 2026년 11월 10일 확인.

인터넷으로 연결하는 앱

ClaudeGooseLM StudioMsty StudioCherry StudioCursorVS Code + GitHub CopilotVisual StudioWindsurf (Devin Desktop)ZedKiroClineContinueJetBrains AI AssistantClaude CodeCodex CLIGemini CLIOpenCodenodecodeWarpLibreChatOpen WebUIRaycast

모든 앱과 장단점 →

할 수 있는 일

서버가 도구 목록을 보여 주기 전에 로그인을 요구해요.

기본 점검i

누구나 볼 수 있는 정보를 점검했고, 코드는 읽지 않았어요. 해당하지 않는 항목은 개수에서 뺐어요. · 2026년 11월 20일 점검

  • ✓ 통과

    제작자와 저장소 일치

    레지스트리 이름이 GitHub 계정 kitplummer 기준으로 확인되었고, 이 계정이 저장소를 소유하고 있어요

  • ✓ 통과

    계속 관리되고 있음

    코드 마지막 변경: 어제

  • ✓ 통과

    라이선스 있음

    BSD-3-Clause 사용

  • ✓ 통과

    엔드포인트 응답

    159ms 만에 응답(HTTP 401)

  • ✓ 통과

    OAuth로 로그인

    OAuth 로그인을 지원한다고 밝혀서, AI 앱이 로그인 화면으로 안내해 줘요

  • … 아직 점검 안 함

    도구 설명에 숨겨진 지시 없음

    아직 점검하지 않았어요. 엔드포인트를 점검할 때 도구 목록을 읽어요

우리가 확인하는 것 → · JSON

제작자: 재확인 요청 또는 잘못된 정보 신고
제작자용: README에 배지 달기

제작자라면 이 코드를 README에 붙여 넣으세요. 배지는 이 페이지로 연결됩니다.

[![Featured on PopNx MCP](https://mcp.popnx.com/badge/kitplummer-lowendinsight.svg)](https://mcp.popnx.com/en/servers/kitplummer-lowendinsight)

토론

질문하고, 팁을 나누고, 안 되는 점을 알려 주세요. "도움이 됨"이 많은 순서예요.

아직 글이 없어요. 처음으로 질문하거나 공유해 보세요.

이곳의 글은 사용자가 쓴 것으로, PopNx 팀의 글이 아니에요.

로그인하고 글쓰기

사용자 리뷰

아직 리뷰가 없어요

로그인하고 리뷰 쓰기

기타 카테고리의 다른 서버와 비교i

  • 이 카테고리의 다른 서버 20958개 중 0%보다 스타가 많아요
  • 이 카테고리의 다른 서버 20958개 중 98%보다 최근에 레지스트리에 공개됐어요
  • 기본 점검 결과가 이 카테고리의 다른 서버 20958개 중 99%와 같거나 더 좋아요

레지스트리에서 이 카테고리의 활성 서버 전체와 비교했어요. 스타는 게시자가 저장소를 소유한 경우에만 세요.

자주 묻는 질문

LowEndInsight, 안전한가요?

해당하는 기본 점검 5개 중 5개를 통과했어요. 코드는 읽지 않았어요. 키나 토큰을 넣기 전에 서버가 어떤 권한을 요구하는지 확인하고, 꼭 필요한 권한만 있는 키를 쓰세요.

어떤 키나 코드가 필요한가요?

입력해야 할 값: Authorization

내 컴퓨터에서 실행되나요, 클라우드에서 실행되나요?

제작자의 클라우드에서 실행돼요. 설치 없이 인터넷으로 연결하지만, 보내는 내용은 제작자의 서버를 거쳐요.

아직 관리되고 있나요?

GitHub 저장소는 마지막으로 어제 변경됐고, 최신 버전(0.16.0-beta.3)은 오늘 레지스트리에 올라왔어요.

어떤 앱에서 쓸 수 있나요?

Claude Desktop, Claude Code, Cursor, VS Code처럼 MCP를 지원하는 앱에서 쓸 수 있어요. URL로 연결되므로 원격 MCP를 받는 앱에서도 쓸 수 있어요. 예: 웹 ChatGPT(Business 이상은 전체 MCP, Pro는 읽기 전용).

대신 쓸 수 있는 건 뭐가 있나요?

같은 카테고리에는: World Monitor, openstatus, Oh My Posh Validator, Strata, Jitsu

비슷하게 동작하는 다른 것

같은 카테고리, 다른 제작자, 명령 확인 완료. 공식이 먼저, 그다음 스타 순.

카드 보는 법:↓ 주간 다운로드i★ GitHub 스타i세 기둥: 리뷰 · 점검 · 사용 정도i업데이트 = 최신 버전을 레지스트리에 공개한 날i

World Monitor

Real-time global intelligence on conflict, markets, energy, trade, shipping and cyber. 100 tools.

제작자: koala73널리 사용됨★ 9.1만4일 전 업데이트

클라우드에서 실행✓ 서비스 회사 · worldmonitor.app

openstatus

Manage monitors, status pages, incidents and maintenances in your openstatus workspace.

제작자: openstatusHQ널리 사용됨★ 9.3천2개월 전 업데이트

클라우드에서 실행✓ 서비스 회사 · openstatus.dev

Strata

MCP server for progressive tool usage at any scale (see https://klavis.ai)

제작자: Klavis-AI성장 중★ 5.8천14개월 전 업데이트

클라우드에서 실행저장소 보관됨✓ klavis.ai

Jitsu

Manage Jitsu data pipelines: destinations, streams, connections, functions, live events.

제작자: jitsucom널리 사용됨★ 5.1천4개월 전 업데이트

클라우드에서 실행✓ 서비스 회사 · jitsu.com
비슷한 항목과 비교
이 항목
LowEndInsight
World MonitoropenstatusOh My Posh ValidatorStrataJitsu
실행 위치클라우드에서 동작, 설치 불필요클라우드에서 동작, 설치 불필요클라우드에서 동작, 설치 불필요클라우드에서 동작, 설치 불필요클라우드에서 동작, 설치 불필요클라우드에서 동작, 설치 불필요
키 필요아니요아니요아니요아니요아니요아니요
Claude에서 +로 추가아니요아니요아니요아니요아니요아니요
기본 점검5/54/44/44/41/44/4
라이선스BSD-3-ClauseAGPL-3.0AGPL-3.0MITApache-2.0MIT
가격등록 정보에 비용 없음등록 정보에 비용 없음등록 정보에 비용 없음등록 정보에 비용 없음등록 정보에 비용 없음등록 정보에 비용 없음

제작자의 README

README 열기

제작자의 저장소에서 쓰인 그대로 가져왔어요. PopNx MCP가 검토하거나 보증한 내용이 아니에요. HTML, 이미지, 스크립트는 제거했어요. 링크를 누르면 이 사이트를 벗어나요.

lowendinsight-get

Supply chain security analysis API for git repositories.

Features

  • URL Analysis: Analyze single or multiple git repository URLs
  • SBOM Analysis: Parse CycloneDX/SPDX SBOMs and analyze all dependencies
  • GitHub Trending: parked (#206) -- the endpoints answer, nothing refreshes them
  • Caching: Redis-backed cache with configurable TTL
  • Cache Modes: blocking, async, stale for flexible cache-miss handling
  • Air-Gap Support: Export/import cache for disconnected environments
  • Job Queue: Oban-based persistent job queue with PostgreSQL

Current Version

Use v0.9.3 (v0.9.2 had CI/Docker networking issues, v0.9.1 had template path issue, v0.9.0 had container build issue)

docker pull ghcr.io/kitplummer/lowendinsight-get:0.9.3

Documentation

  • [Interactive API Docs](http://localhost:4000/doc) - Swagger UI for exploring and testing the API
  • [API Reference](docs/API.md) - Complete REST API documentation
  • [Operations Guide](docs/OPERATIONS.md) - Deployment, configuration, and maintenance

Quick Start

See lowendinsight's README for more details on the underlying functionality: https://github.com/kitplummer/lowendinsight

The workflow for this API is asynchronous. The POST to /v1/analyze will return immediately, providing you with a uuid for the job.

You then can do a GET to /v1/analyze/:uuid (with your newly minted ID) to retrieve the results. The analyzer job will change state from "incomplete" to "complete" when the analysis is done.

Unfortunately some git repositories are just huge, and will take time to download - even a single branch. The service does employ a basic cache, and can be configured with a TTL. The default is set to sweep out reports at 30 days.

Configuration

Look at config/config.exs or if you're building your own container rel/config/prod.exs (which is used as the container's prod config :)) for how to set the governance par levels, and the cache TTL.

The configuration items are also explained at https://github.com/kitplummer/lowendinsight in more detail.

Note: For Windows, avoid using single quotes in commands. Use double quotes instead and escape nested quotes i.e. use \"

Run

Development

You can run with mix but you'll have to ensure a provided Redis service is available and the correct configuration is referenced in config/config.exs. Then you run: mix run --no-halt.

Don't forget to get fetch the dependencies:

mix deps.get && mix run --no-halt
Production

Well, if you're at this point I'd recommend using the Docker Compose or Kubernetes deployments. Configuration for both are found in the repo.

The docker-compose.yml will spin up a Redis db and the LowEndInsight containers, exposing the services. You can simply run docker-compose up to launch things.

Within the k8s subdirectory you'll find configuration files for both Redis (single node configuration) and LowEndInsight. For example:

➜  kubectl apply -f k8s/redis-master-deployment.yaml

deployment.apps/redis-master created ➜ kubectl apply -f k8s/redis-master-service.yaml service/redis-master created ➜ kubectl apply -f k8s/deployment.yaml deployment.apps/lei-get created ➜ kubectl apply -f k8s/service.yaml service/lei-get created ➜ kubectl get all NAME READY STATUS RESTARTS AGE pod/lei-get-7f4bd755c9-7m6fz 1/1 Running 0 23s pod/redis-master-7db7f6579f-x97df 1/1 Running 0 37s

NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE service/kubernetes ClusterIP 10.96.0.1 443/TCP 17d service/lei-get LoadBalancer 10.96.15.135 4000:32224/TCP 17s service/redis-master ClusterIP 10.96.247.238 6379/TCP 33s

NAME READY UP-TO-DATE AVAILABLE AGE deployment.apps/lei-get 1/1 1 1 23s deployment.apps/redis-master 1/1 1 1 37s

NAME DESIRED CURRENT READY AGE replicaset.apps/lei-get-7f4bd755c9 1 1 1 23s replicaset.apps/redis-master-7db7f6579f 1 1 1 37s

Heroku

It's also possible to run this in Heroku using the Elixir buildpack. The Redis configuration requires the Heroku Redis addon which will set the REDIS_URL environment variable. The procfile at the root of the repo is used by the buildpack to run the app. While this isn't a Phoenix app I used this URL as a guide:

https://hexdocs.pm/phoenix/heroku.html

And this one for the Redis setup:

https://devcenter.heroku.com/articles/heroku-redis#provisioning-the-add-on

REST API

Full API documentation: [docs/API.md](docs/API.md)

Core Endpoints
MethodEndpointDescription
POST/v1/analyzeAnalyze git repository URLs
GET/v1/analyze/:uuidGet analysis results by job ID
POST/v1/analyze/sbomAnalyze SBOM (CycloneDX/SPDX)
API Documentation
MethodEndpointDescription
GET/docSwagger UI - interactive API explorer
GET/openapi.jsonOpenAPI 3.0 specification (JSON)
Cache Management
MethodEndpointDescription
GET/v1/cache/statsGet cache statistics
GET/v1/cache/exportExport cache for air-gapped deployment
POST/v1/cache/importImport pre-warmed cache
GitHub Trending (parked, #206: nothing refreshes these)
MethodEndpointDescription
GET/gh_trendingList available languages
GET/gh_trending/:languageView trending report for language
POST/v1/gh_trending/processTrigger trending analysis (async)
Example: Analyze URLs
curl -X POST 'http://localhost:4000/v1/analyze' \

-H 'Authorization: Bearer $TOKEN' \ -H 'Content-Type: application/json' \ -d '{"urls":["https://github.com/owner/repo"], "cache_mode": "blocking"}'

Example: Analyze SBOM
curl -X POST 'http://localhost:4000/v1/analyze/sbom' \

-H 'Authorization: Bearer $TOKEN' \ -H 'Content-Type: application/json' \ -d '{"sbom": {"bomFormat":"CycloneDX","components":[...]}, "cache_mode": "async"}'

Example: Export/Import Cache (Air-Gap)
# Export from connected environment

curl -H 'Authorization: Bearer $TOKEN' \ https://lei.example.com/v1/cache/export > cache.json

Import to air-gapped environment

curl -X POST 'http://lei-local:4000/v1/cache/import' \ -H 'Authorization: Bearer $TOKEN' \ -H 'Content-Type: application/json' \ -d @cache.json

License

See LICENSE

# Copyright (C) 2020 by the Georgia Tech Research Institute (GTRI)

This software may be modified and distributed under the terms of

the BSD 3-Clause license. See the LICENSE file for details.

Contributing

Thanks for considering, we need your contributions to help this project come to fruition.

Here are some important resources:

  • Bugs? Issues is where to report them
Style

The repo includes auto-formatting, please run mix format to format to the standard style prescribed by the Elixir project:

https://hexdocs.pm/mix/Mix.Tasks.Format.html

https://github.com/christopheradams/elixir_style_guide

Code docs for functions are expected. Examples are a bonus:

https://hexdocs.pm/elixir/writing-documentation.html

Testing

Required. Please write ExUnit test for new code you create.

Use mix test --cover to verify that you're maintaining coverage.

Github Actions

Just getting this built-out. But the bitbucket-pipeline config is still here too.

Submitting changes

Please send a Pull Request with a clear list of what you've done and why. Please follow Elixir coding conventions (above in Style) and make sure all of your commits are atomic (one feature per commit).

Always write a clear log message for your commits. One-line messages are fine for small changes, but bigger changes should look like this:

$ git commit -m "A brief summary of the commit

A paragraph describing what changed and its impact."