Add contributing guide. #732
Conversation
The typos are fixed, so removing my “Changes requested” status.
docs/contributing.md
Outdated
| `MAJOR.MINOR.POINT(PRERELEASE/DEV)` format for specifying releases. The status | ||
| of the `master` branch should always be identified in the `__version_info__` | ||
| variable defined in [`markdown/__init__.py`][markdown/__init__.py] and should | ||
| conform to [PEP 440]. |
There was a problem hiding this comment.
Note that we currently conform to PEP 386, which had been superseded by 440. We will need to make a minor adjustment before we conform to this guide.
There was a problem hiding this comment.
Just a note that pypa/packaging officially implements PEP 404. And as of pypa/setuptools@9382fa0c, (version 8.0) setuptools and pkg_resources vendor and use pypa/packaging to do all version parsing. Finally, since 52b8da8 (version 3.0) we are using setuptools for installation.
Therefore, the differences between pkg_resources and PEP 440 listed in the PEP are presumably outdated and we should be able to use pkg_resources for all version handling without any added dependencies. In other words, we can remove our own version parsing code when conforming to PEP 440.
Also update to be PEP 440 compliant in preparation for Python-Markdown#732.
Update version format to be PEP 440 compliant in preparation for #732. Add `pyproject.toml` file and configure tox to use it. Define requirement for `setuptools>=36` which validates and normalizes the version format.
All issues raised have been addressed.
A first draft. It's still a little rough and incomplete.
|
I just pushed a change which now allows usage questions to be asked as GitHub Issues. I also included a list of [labels] and a description of each. Note that many new labels have been introduced. Please provide any feedback you may have before I update GitHub with the new labels. |
|
I have no complaints. |
|
I have updated the labels here in GitHub. I used a color scheme for the status labels which is reminiscent of traffic lights: green: various approved states (expect for All other labels (types and categories) arbitrarily use blue, orange, purple, brown... not shades of green/yellow/red. |
|
Yeah, I may steal the label convention or at least adapt it for some other projects. I've always had problems coming up with a label system I was happy with. |
|
I think this is done. I did a final review and only found a couple minor tweaks. I also color coded the labels in the docs. Any tweaks to the CSS are welcome:
|
A first draft. It's still a little rough and incomplete.
Any and all feedback is welcome.
For the record I found inspiration from