add developer notes #17

Jonathanlyj · 2024-07-25T03:59:14Z

Developer note should contain the following information.

Tasks for making a new release
- Convention of setting version number. See http://semver.org/
Register the new release on PiPy
Instructions for developer installation
Python software environment issues
Source code convention, including style of comments
Instructions of creating new CI tasks
- github workflow, yaml files
- readthedocs workflow, configure files

wkliao · 2024-09-03T06:06:09Z

Please add instructions about register PnetCDF-Python in PyPI.

* Also, move DEVELOPER_NOTES.md to folder docs.

Jonathanlyj and others added 10 commits September 11, 2024 16:27

start a developer notes

3c4bd29

modify DEVELOPER_NOTES.md to include user guide generation details

83b9b2b

updated developer notes about installation

7286987

notes about MANIFEST.in file

99bca67

add notes about wheel and source distribution

46dc7a0

add notes about packaging and testpypi publishing

6e87ecc

delete repeated commands

4a2d463

added notes about PyPI uploads

e900041

fix indentation

11728ab

Add tasks of making a new release

67e5b45

* Also, move DEVELOPER_NOTES.md to folder docs.

wkliao force-pushed the developer_notes branch from cdc8ed7 to 67e5b45 Compare September 11, 2024 21:28

wkliao changed the title ~~add developer notes to include user guide config~~ add developer notes Sep 11, 2024

wkliao and others added 3 commits September 12, 2024 13:17

Add note on updating a tag when new commits were added

d8288bb

Added packaging and publishing details to DEVELOPER_NOTES.md

69240cb

Revise and reformat DEVELOPER_NOTES.md

ac35bbb

wkliao force-pushed the developer_notes branch from f52756c to ac35bbb Compare November 12, 2024 21:54

wkliao merged commit 8f789d1 into main Nov 12, 2024
1 check passed

Provide feedback