jmcarp / jmcarp/flask-apispec

Add Contributing Guidelines for project

Open
#158 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
652
Forks
151
PR merge metrics
No merged PRs in 30d

Description

This project may benefit from a CONTRIBUTING.rst file showing how to get setup with development and expectations for contributors. I would probably base it off https://github.com/marshmallow-code/marshmallow/blob/dev/CONTRIBUTING.rst other than the stuff specific to marshmallow.

Would we be open to a PR for this?

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reading the marshmallow CONTRIBUTING.rst file linked in the issue and inspect the flask-apispec project for details that need to differ. Add a project-specific CONTRIBUTING.rst covering development setup and contributor expectations; it is done when those guidelines are documented in the new file.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
Half a day
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.