Skip to content

Commit

Permalink
Merge pull request #2 from Isaak-Malers/1-add-contributing-documentation
Browse files Browse the repository at this point in the history
Update developer.md to including information for contributors and a b…
  • Loading branch information
Isaak-Malers authored Feb 21, 2024
2 parents 2e263ea + 277295f commit c77c8d3
Showing 1 changed file with 13 additions and 3 deletions.
16 changes: 13 additions & 3 deletions developer.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,23 @@
# Note:
# Contributing:

This project uses trunk based development, but with an understanding that open source moves a little slower. Please following the following steps to contribute.

Steps to Contribute:
1. Create, or find an issue. All branches must be tied to a github issue.
2. Create a branch for your issue. It should be named after the issue number and with an optional description
3. Make and test feature/fix/change on the branch
4. Add Pull request for the branch, ensuring issue is linked so that reviewers have context for the changeset.

## Note:
this information condensed from: https://packaging.python.org/en/latest/tutorials/packaging-projects/

# Building
## Building

to build dist. CD into the root repository directory:
```python -m build```
this will create a "dist" directory with a wheel and a tar.gz file.

# Publishing
## Publishing

To publish (from windows) Note you must paste an access token for PyPi here:
```python -m twine upload -u __token__ -p [PUT PIPY TOKEN HERE] dist/*```

0 comments on commit c77c8d3

Please sign in to comment.