diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..d77dd59 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,33 @@ +# Contributing + +## Development Setup + +1. Fork and clone the repository. +2. Create a virtual environment. +3. Install the project in editable mode. + +```bash +python3 -m venv .venv +source .venv/bin/activate +python -m pip install -e . +``` + +## Running Tests + +Run the test suite before opening a pull request. + +```bash +python -m unittest discover -s tests +``` + +## Pull Requests + +1. Keep changes focused and minimal. +2. Add or update tests when behavior changes. +3. Update documentation when user-facing behavior changes. +4. Open a pull request with a clear description of the change. + +## Notes + +- CI runs automatically for pull requests. +- Markdown-only changes do not trigger the test workflow. diff --git a/README.md b/README.md index 51932d2..1f637e3 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ Pending endpoints are listed later in this document. ## 1. Installation ```bash -pip install jenga +pip install paymentsdks-jenga ``` ## 2. Configuration @@ -199,6 +199,7 @@ PYTHONPATH=src python3 -m jenga.cli account-balance --country-code KE --account- - This package currently focuses on a small subset of Jenga APIs. - The README only documents endpoints that are actually implemented in this repository. - Pending endpoints are listed for roadmap visibility only. +- See the [contribution guide](./CONTRIBUTING.md) for development and pull request workflow. ## 7. License -License: [MIT](./LICENSE) \ No newline at end of file +License: [MIT](./LICENSE) diff --git a/pyproject.toml b/pyproject.toml index 7886366..5bbb933 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -3,7 +3,7 @@ requires = ["setuptools>=68"] build-backend = "setuptools.build_meta" [project] -name = "jenga" +name = "paymentsdks-jenga" version = "0.1.0" description = "Minimal Python client for selected Jenga APIs" license = { text = "MIT" }