From 1a2b9d76767bb50d0ddb306610089ed9a1038986 Mon Sep 17 00:00:00 2001 From: Yuqiang Wang <10815391+schchit@users.noreply.github.com> Date: Sat, 26 Sep 2026 08:48:56 -0500 Subject: [PATCH] docs: simplify entry points and clarify current format boundaries --- CONTRIBUTING.md | 63 +++++++++++-------------------------------------- NOTICE.md | 2 +- 2 files changed, 15 insertions(+), 50 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3ccbaac..5ef5d6e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,56 +1,21 @@ -# Contributing to HJS CLI +# Contributing to JEP CLI -Thank you for your interest in contributing to **HJS CLI**, the command-line interface for the HJS protocol! We welcome contributions from everyone, whether you're fixing a bug, improving documentation, or proposing new features. +This is a Python HTTP client for the JEP API. Use the [issue tracker](https://github.com/hjs-spec/cli/issues) and follow the [Code of Conduct](CODE_OF_CONDUCT.md). -## Code of Conduct +## Develop -This project follows our [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you agree to uphold its standards. Reports can be sent to [signal@humanjudgment.org](mailto:signal@humanjudgment.org). +Python 3.9 or newer is required. -## Ways to Contribute - -### 📝 Issues -Report bugs, suggest improvements, or ask questions via [GitHub Issues](https://github.com/hjs-protocol/cli/issues). - -| Issue Type | Guidelines | -|------------|------------| -| **Bug reports** | Include steps to reproduce, expected behavior, and actual behavior | -| **Feature suggestions** | Explain the use case and alignment with HJS core primitives | -| **Questions** | Use issues for technical questions about the CLI | - -### 🔧 Pull Requests -Submit code changes, fixes, or improvements. - -1. **Fork** the repository -2. **Create a branch** (`git checkout -b feature/your-feature`) -3. **Make your changes**, following our guidelines -4. **Write tests** for new functionality -5. **Run linting** (`npm run lint` if available) -6. **Commit with clear messages** (see [Conventional Commits](https://www.conventionalcommits.org/)) -7. **Push to your fork** and submit a Pull Request - -### 💬 Discussions -reach out via [signal@humanjudgment.org](mailto:signal@humanjudgment.org). - -## Development Setup - -### Prerequisites - -- Node.js 18 or higher -- npm (comes with Node.js) -- Git - -### Local Setup - -```bash -# Clone the repository -git clone https://github.com/hjs-protocol/cli.git +```sh +git clone https://github.com/hjs-spec/cli.git cd cli +python -m venv .venv +. .venv/bin/activate +python -m pip install -e '.[dev]' +python -m pytest -q +jep --help +``` -# Install dependencies -npm install - -# Link the CLI locally -npm link +Keep each pull request focused. Test changed behavior and update CLI documentation. The command is `jep`; `jep-agent` and `jep-runtime` belong to separate packages. Protocol requirements stay in [Core](https://github.com/hjs-spec/jep-core). -# Test the installation -hjs --help +Contact: signal@humanjudgment.org. diff --git a/NOTICE.md b/NOTICE.md index f4eeba0..d995d4f 100644 --- a/NOTICE.md +++ b/NOTICE.md @@ -1,6 +1,6 @@ # Notice -This repository contains an experimental CLI seed for the JEP v0.6 API. +This repository contains an experimental CLI seed for the JEP reference API. Supported protocol revisions are documented in README.md. Internet-Draft text and excerpts are governed by the IETF Trust Legal Provisions and BCP 78 / BCP 79.