From 6d0ae804d8f3be90baa21819d27d197a0cf4477a Mon Sep 17 00:00:00 2001 From: Mark DeLaVergne Date: Wed, 1 Apr 2026 16:03:30 -0400 Subject: [PATCH 1/2] Consolidate instructions on CONTRIBUTING.md, and include release process --- CONTRIBUTING.md | 86 ++++++++++++++++++++++++++++++++++++++++++++- FOR_CONTRIBUTORS.md | 82 ------------------------------------------ 2 files changed, 85 insertions(+), 83 deletions(-) delete mode 100644 FOR_CONTRIBUTORS.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 03e14c7..3778116 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -21,9 +21,93 @@ Use GitHub Issues page to submit issues, enhancement requests and discuss ideas. - Issues that have been identified as a feature request will be labelled `enhancement`. -# Issues +### Issues We use GitHub issues to track public bugs. Please ensure your description is clear and has sufficient instructions to be able to reproduce the issue. # Code of Conduct Please follow our [Code of Conduct](CODE_OF_CONDUCT.md). + +# Development + +## Quick Start + +### Prerequisites + +See the [Prerequisites section in README.md](./README.md#prerequisites) for complete setup requirements. + +### Initial Setup + +1. **Clone the repository** + ```bash + git clone + cd datacloud-customcode-python-sdk + ``` + +2. **Set up virtual environment and install dependencies** + + **Note**: If you need to set a specific Python version, use `pyenv local 3.11.x` in the project directory. + + ```bash + python3.11 -m venv .venv + source .venv/bin/activate + pip install poetry + make develop + ``` + +3. **Verify installation** + ```bash + datacustomcode version + ``` + +4. **Initialize a project for development work verification** + + **Note**: To test your changes and develop new features, initialize a sample project: + + ```bash + # Create a new directory for your test project + mkdir my-test-project + cd my-test-project + + # Initialize a new Data Cloud custom code project + datacustomcode init . + + # Test your SDK modifications against the sample project with: + datacustomcode run ./payload/entrypoint.py + ``` + + **Tip**: See the [README.md](./README.md) for additional `datacustomcode` commands (`scan`, `deploy`, `zip`) to test specific code paths and validate your SDK changes thoroughly. + +## Makefile Commands + +```bash +# Clean build artifacts, caches and temporary files +make clean + +# Build package distribution +make package + +# Install main dependencies only +make install + +# Install dependencies for full development setup +make develop + +# Run code quality checks +make lint + +# Perform static type checking +make mypy + +# Run complete test suite +make test +``` + +## Release process + +1. Go to [releases page](https://github.com/forcedotcom/datacloud-customcode-python-sdk/releases) +1. Click "Draft a new release" +1. Click "Select tag" and manually enter the next logical version, e.g. v1.2.3 +1. Use "Generate release notes" button +1. Keep "Set as the latest release" checkbox +1. Click "Publish release" diff --git a/FOR_CONTRIBUTORS.md b/FOR_CONTRIBUTORS.md deleted file mode 100644 index 651a60e..0000000 --- a/FOR_CONTRIBUTORS.md +++ /dev/null @@ -1,82 +0,0 @@ -# New Developer Guide - Data Cloud Custom Code Python SDK - -Welcome to the Salesforce Data Cloud Custom Code Python SDK! This guide will help you get started with development and contribution to this repository. - -## 🚀 Quick Start - -### Prerequisites - -See the [Prerequisites section in README.md](./README.md#prerequisites) for complete setup requirements. - -### Initial Setup - -1. **Clone the repository** - ```bash - git clone - cd datacloud-customcode-python-sdk - ``` - -2. **Set up virtual environment and install dependencies** - - **Note**: If you need to set a specific Python version, use `pyenv local 3.11.x` in the project directory. - - ```bash - python3.11 -m venv .venv - source .venv/bin/activate - pip install poetry - make develop - ``` - -3. **Verify installation** - ```bash - datacustomcode version - ``` - -4. **Initialize a project for development work** - - **Note**: To test your changes and develop new features, initialize a sample project: - - ```bash - # Create a new directory for your test project - mkdir my-test-project - cd my-test-project - - # Initialize a new Data Cloud custom code project - datacustomcode init . - - # Test your SDK modifications against the sample project with: - datacustomcode run ./payload/entrypoint.py - ``` - - **Tip**: See the [README.md](./README.md) for additional `datacustomcode` commands (`scan`, `deploy`, `zip`) to test specific code paths and validate your SDK changes thoroughly. - -## 🔧 Makefile Commands - -The project includes a comprehensive Makefile for common development tasks: - -```bash -# Clean build artifacts, caches and temporary files -make clean - -# Build package distribution -make package - -# Install main dependencies only -make install - -# Install dependencies for full development setup -make develop - -# Run code quality checks -make lint - -# Perform static type checking -make mypy - -# Run complete test suite -make test -``` - ---- - -**Welcome to the community!** If you have any questions or need help getting started, don't hesitate to create an issue in the repository or reach out to the maintainers through the project's communication channels. From 459baf82f377f7c3cd9336b44b0d3c861d449f1f Mon Sep 17 00:00:00 2001 From: Mark DeLaVergne Date: Fri, 3 Apr 2026 11:16:36 -0400 Subject: [PATCH 2/2] Remove release process, will go into internal docs --- CONTRIBUTING.md | 9 --------- 1 file changed, 9 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3778116..13ab48b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -102,12 +102,3 @@ make mypy # Run complete test suite make test ``` - -## Release process - -1. Go to [releases page](https://github.com/forcedotcom/datacloud-customcode-python-sdk/releases) -1. Click "Draft a new release" -1. Click "Select tag" and manually enter the next logical version, e.g. v1.2.3 -1. Use "Generate release notes" button -1. Keep "Set as the latest release" checkbox -1. Click "Publish release"