Document git flow (#56)

* Update references to hackathan repo to new name

* Document git flow setup

* Revise opening line in readme

Author: rlskoeser

CONTRIBUTING.md

@@ -3,7 +3,7 @@
 
 Hey there!
 
-If you found your way here that probably means you are curious about how to contribute to this project. This is great! We are always looking for new contributors. If you can't find the information you are looking for in this document or anywhere else in the repo, please consider [opening a ticket](https://github.com/dh-tech/hackathon-2022/issues) so we know there is something we need to address.
+If you found your way here that probably means you are curious about how to contribute to this project. This is great! We are always looking for new contributors. If you can't find the information you are looking for in this document or anywhere else in the repo, please consider [opening a ticket](https://github.com/dh-tech/undate-python/issues) so we know there is something we need to address.
 
 ## Project Setup
 Instructions on how to set up the project locally and how to run the tests can be found [in the Readme file](README.md).
@@ -12,7 +12,7 @@ Instructions on how to set up the project locally and how to run the tests can b
 If you would like to contribute by submitting bug fixes, improvements, or new features, please fork the repository and then make a pull request to our main branch when you are ready. For details see [this description of the Forking Workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/forking-workflow).
 
 ## Submitting Bug Reports and Feature Requests
-If you find a bug or can think a feature you would really like to see being implemented, you can [create a new issue](https://github.com/dh-tech/hackathon-2022/issues). Please first look through the existing issues, however, to avoid duplication of issues.
+If you find a bug or can think a feature you would really like to see being implemented, you can [create a new issue](https://github.com/dh-tech/undate-python/issues). Please first look through the existing issues, however, to avoid duplication of issues.
 
 If you report a bug, please include any error messages you get and a full description of the steps to reproduce the bug. For new feature requests, please clearly describe the functionality you are looking for and, if applicable, why any existing workflow does not suffice. Please also consider, fixing bugs and implementing new features yourself and submit pull request! :) 
 

README.md

@@ -1,10 +1,12 @@
-# hackathon-2022
+# undate-python
 
-Repository for the DHTech 2022 Hackathon
+`undate` is a python library for working with uncertain or partially known dates.
+
+It was initially created as part of a DH-Tech hackathon in November 2022.
 
 [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
-[![unit tests](https://github.com/dh-tech/hackathon-2022/actions/workflows/unit_tests.yml/badge.svg)](https://github.com/dh-tech/hackathon-2022/actions/workflows/unit_tests.yml)
-[![codecov](https://codecov.io/gh/dh-tech/hackathon-2022/branch/main/graph/badge.svg?token=GE7HZE8C9D)](https://codecov.io/gh/dh-tech/hackathon-2022)
+[![unit tests](https://github.com/dh-tech/undate-python/actions/workflows/unit_tests.yml/badge.svg)](https://github.com/dh-tech/undate-python/actions/workflows/unit_tests.yml)
+[![codecov](https://codecov.io/gh/dh-tech/undate-python/branch/main/graph/badge.svg?token=GE7HZE8C9D)](https://codecov.io/gh/dh-tech/undate-python)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
 [![All Contributors](https://img.shields.io/badge/all_contributors-5-orange.svg?style=flat-square)](#contributors-)
@@ -18,22 +20,38 @@ This software is licensed under the [Apache 2.0 License](LICENSE.md).
 
 To install the latest development version from GitHub:
 ```sh
-pip install git+https://github.com/dh-tech/hackathon-2022.git@main#egg=undate
+pip install git+https://github.com/dh-tech/undate-python.git@main#egg=undate
 ```
 
 To install a specific release or branch, run the following (replace `[tag-name]` with the tag or branch you want to install):
 ```sh
-pip install git+https://github.com/dh-tech/hackathon-2022.git@[tag-name]
+pip install git+https://github.com/dh-tech/undate-python.git@[tag-name]
 ```
 
 ## Instructions to setup for development
 
 ### Clone repo
 ```
-$ git clone [email protected]:dh-tech/hackathon-2022.git
-cd hackathon-2022
+$ git clone [email protected]:dh-tech/undate-python.git
+cd undate-python
 ```
 
+## Setup and initialize git flow
+
+This repository uses [git-flow](https://github.com/nvie/gitflow) branching conventions:
+- **main** will always contain the most recent release
+- **develop** branch is the latest version of work in progress
+
+Pull requests should be made against the **develop** branch.
+
+It is recommended to install git flow (on OSX, use brew or ports, e.g.: `brew install git-flow`;
+on Ubuntu/Debian, `apt-get install git-flow`) and then initialize it in this repository
+via `git flow init` and accept the defaults.  Then you can use `git flow feature start`
+to create feature development branches.
+
+Alternately, you can check out the develop branch (`git checkout develop`)
+and create your branches manually based on develop (`git checkout -b feature/xxx-name`).
+
 ### Set up Python environment
 Use a recent version of python 3.x; recommended to use a virtualenv, e.g.
 ```
@@ -55,7 +73,7 @@ pre-commit install
 ```
 
 ### Run unit tests
-Tests can be run with either `tox` or `pytest`.  
+Tests can be run with either `tox` or `pytest`.
 
 To run all the tests in a single test file, use pytest and specify the path to the test: `pytest tests/test_dateformat/test_base.py`
 
@@ -75,11 +93,11 @@ tox -e docs
 <table>
   <tbody>
     <tr>
-      <td align="center"><a href="https://github.com/ColeDCrawford"><img src="https://avatars.githubusercontent.com/u/16374762?v=4?s=100" width="100px;" alt="Cole Crawford"/><br /><sub><b>Cole Crawford</b></sub></a><br /><a href="https://github.com/dh-tech/hackathon-2022/commits?author=ColeDCrawford" title="Code">💻</a> <a href="https://github.com/dh-tech/hackathon-2022/pulls?q=is%3Apr+reviewed-by%3AColeDCrawford" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/dh-tech/hackathon-2022/commits?author=ColeDCrawford" title="Tests">⚠️</a></td>
-      <td align="center"><a href="http://rlskoeser.github.io"><img src="https://avatars.githubusercontent.com/u/691231?v=4?s=100" width="100px;" alt="Rebecca Sutton Koeser"/><br /><sub><b>Rebecca Sutton Koeser</b></sub></a><br /><a href="https://github.com/dh-tech/hackathon-2022/commits?author=rlskoeser" title="Code">💻</a> <a href="https://github.com/dh-tech/hackathon-2022/pulls?q=is%3Apr+reviewed-by%3Arlskoeser" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/dh-tech/hackathon-2022/commits?author=rlskoeser" title="Tests">⚠️</a></td>
+      <td align="center"><a href="https://github.com/ColeDCrawford"><img src="https://avatars.githubusercontent.com/u/16374762?v=4?s=100" width="100px;" alt="Cole Crawford"/><br /><sub><b>Cole Crawford</b></sub></a><br /><a href="https://github.com/dh-tech/undate-python/commits?author=ColeDCrawford" title="Code">💻</a> <a href="https://github.com/dh-tech/undate-python/pulls?q=is%3Apr+reviewed-by%3AColeDCrawford" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/dh-tech/undate-python/commits?author=ColeDCrawford" title="Tests">⚠️</a></td>
+      <td align="center"><a href="http://rlskoeser.github.io"><img src="https://avatars.githubusercontent.com/u/691231?v=4?s=100" width="100px;" alt="Rebecca Sutton Koeser"/><br /><sub><b>Rebecca Sutton Koeser</b></sub></a><br /><a href="https://github.com/dh-tech/undate-python/commits?author=rlskoeser" title="Code">💻</a> <a href="https://github.com/dh-tech/undate-python/pulls?q=is%3Apr+reviewed-by%3Arlskoeser" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/dh-tech/undate-python/commits?author=rlskoeser" title="Tests">⚠️</a></td>
       <td align="center"><a href="https://github.com/robcast"><img src="https://avatars.githubusercontent.com/u/1488847?v=4?s=100" width="100px;" alt="Robert Casties"/><br /><sub><b>Robert Casties</b></sub></a><br /><a href="#data-robcast" title="Data">🔣</a></td>
-      <td align="center"><a href="https://github.com/jdamerow"><img src="https://avatars.githubusercontent.com/u/8881141?v=4?s=100" width="100px;" alt="Julia Damerow"/><br /><sub><b>Julia Damerow</b></sub></a><br /><a href="https://github.com/dh-tech/hackathon-2022/commits?author=jdamerow" title="Code">💻</a> <a href="https://github.com/dh-tech/hackathon-2022/pulls?q=is%3Apr+reviewed-by%3Ajdamerow" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/dh-tech/hackathon-2022/commits?author=jdamerow" title="Tests">⚠️</a> <a href="#eventOrganizing-jdamerow" title="Event Organizing">📋</a></td>
-      <td align="center"><a href="https://github.com/maltevogl"><img src="https://avatars.githubusercontent.com/u/20907912?v=4?s=100" width="100px;" alt="Malte Vogl"/><br /><sub><b>Malte Vogl</b></sub></a><br /><a href="https://github.com/dh-tech/hackathon-2022/commits?author=maltevogl" title="Code">💻</a> <a href="https://github.com/dh-tech/hackathon-2022/pulls?q=is%3Apr+reviewed-by%3Amaltevogl" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/dh-tech/hackathon-2022/commits?author=maltevogl" title="Tests">⚠️</a> <a href="https://github.com/dh-tech/hackathon-2022/commits?author=maltevogl" title="Documentation">📖</a></td>
+      <td align="center"><a href="https://github.com/jdamerow"><img src="https://avatars.githubusercontent.com/u/8881141?v=4?s=100" width="100px;" alt="Julia Damerow"/><br /><sub><b>Julia Damerow</b></sub></a><br /><a href="https://github.com/dh-tech/undate-python/commits?author=jdamerow" title="Code">💻</a> <a href="https://github.com/dh-tech/undate-python/pulls?q=is%3Apr+reviewed-by%3Ajdamerow" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/dh-tech/undate-python/commits?author=jdamerow" title="Tests">⚠️</a> <a href="#eventOrganizing-jdamerow" title="Event Organizing">📋</a></td>
+      <td align="center"><a href="https://github.com/maltevogl"><img src="https://avatars.githubusercontent.com/u/20907912?v=4?s=100" width="100px;" alt="Malte Vogl"/><br /><sub><b>Malte Vogl</b></sub></a><br /><a href="https://github.com/dh-tech/undate-python/commits?author=maltevogl" title="Code">💻</a> <a href="https://github.com/dh-tech/undate-python/pulls?q=is%3Apr+reviewed-by%3Amaltevogl" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/dh-tech/undate-python/commits?author=maltevogl" title="Tests">⚠️</a> <a href="https://github.com/dh-tech/undate-python/commits?author=maltevogl" title="Documentation">📖</a></td>
     </tr>
   </tbody>
 </table>

setup.cfg

@@ -11,7 +11,7 @@ long_description_content_type = text/markdown
 url = https://github.com/dh-tech/hackathon-2022
 project_urls =
     Project Home = https://dh-tech.github.io
-    Bug Tracker = https://github.com/dh-tech/hackathon-2022/-/issues
+    Bug Tracker = https://github.com/dh-tech/undate-python/issues
 classifiers =
     Development Status :: 2 - Pre-Alpha
     Programming Language :: Python :: 3