search

microsoft / sammo

A library for prompt engineering and optimization (SAMMO = Structure-aware Multi-Objective Metaprompt Optimization)
MIT License
581 stars 29 forks source link

Add guidelines/workflow for contributors #5

Closed onkarbhardwaj closed 9 months ago

onkarbhardwaj commented 10 months ago

Request to add guidelines/workflow somewhere in README or CONTRIBUTING.md - For example, how to replicate the environment, pre-commit hooks, formatting/linting (e.g., black/flake8) that's expected for a PR to be accepted.

pbourke commented 10 months ago

Thanks for opening this issue. I'm setting up our initial pre-commit hooks and have created the CONTRIBUTING.md file as part of that PR. There is more to be added to the file, but it does mention installation of pre-commit hooks. black will be run from a hook.

I anticipate adding others (such as flake8 as you mention)

pbourke commented 9 months ago

Reopening this issue to track ongoing work for contributor guidelines