diff --git a/CHANGES.md b/CHANGES.md index 2fd3f54..a52df11 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -1,4 +1,4 @@ 0.0.1 - first version ---------------------- - - setting up the project + - first initial release diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 59f14fc..77e2f37 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,7 +11,7 @@ Types of Contributions ### Report Bugs -Report bugs at https://github.com/holgi/ordr3/issues. +Report bugs at https://git.cpi.imtek.uni-freiburg.de/holgi/ordr3/issues. If you are reporting a bug, please include: @@ -21,12 +21,12 @@ If you are reporting a bug, please include: ### Fix Bugs -Look through the GitHub issues for bugs. Anything tagged with "bug" and "help +Look through the git issues for bugs. Anything tagged with "bug" and "help wanted" is open to whoever wants to implement it. ### Implement Features -Look through the GitHub issues for features. Anything tagged with "enhancement" +Look through the git issues for features. Anything tagged with "enhancement" and "help wanted" is open to whoever wants to implement it. ### Write Documentation @@ -37,7 +37,7 @@ articles, and such. ### Submit Feedback -The best way to send feedback is to file an issue at https://github.com/holgi/ordr3/issues. +The best way to send feedback is to file an issue at https://git.cpi.imtek.uni-freiburg.de/holgi/ordr3/issues If you are proposing a feature: @@ -54,7 +54,7 @@ Ready to contribute? Here's how to set up `ordr3` for local development. 1. Fork the `ordr3` repo on GitHub. 2. Clone your fork locally:: - `$ git clone git@github.com:your_name_here/ordr3.git` + `$ git clone https://git.cpi.imtek.uni-freiburg.de/holgi/ordr3.git` 3. Install your local copy into a virtualenv. @@ -92,9 +92,8 @@ Pull Request Guidelines Before you submit a pull request, check that it meets these guidelines: 1. The pull request should include tests. -2. If the pull request adds functionality, the docs should be updated. Put - your new functionality into a function with a docstring, and add the - feature to the list in README.md and CHANGES.md +2. If the pull request adds functionality, the docs should be updated. +Put your new functionality into a function with a docstring, and add the feature to the list in README.md and CHANGES.md Tips ---- @@ -113,5 +112,4 @@ make sure all your changes are committed (including an entry in CHANGES.md). $ git tag $ git push $ git push --tags - $ flit publish diff --git a/README.md b/README.md index 18700c5..d17b446 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,26 @@ Ordr3 ===== -A rewrite of our CPI ordering system. +Our old and trusted ordering system (developed in 2012) was showing its age. Since the original application had no automatic tests, a complete rewrite was done. -## Example: +Decisions and goals in this project: -```python - - import ordr3 - - ordr3.run() -``` +- make a "classical" web app with a little bit Javascript sprinkled in +- [Python](https://www.python.org) as main programming language +- [SQLite](https://duckduckgo.com/) as database backend +- [Pyramid](https://trypyramid.com) as web framework +- leverage the design principles shown in [Cosmic Python](https://github.com/cosmicpython/book/blob/master/Readme.md) +- have automatic unit test and functional tests, the coverage should be above 90% +- complete data migration from the old system +This new system is now online at https://ordr.cpi.imtek.uni-freiburg.de since late April 2020 ## Development To install the development version of Ordr3: - git clone https://github.com/holgi/ordr3.git - + git clone https://git.cpi.imtek.uni-freiburg.de/holgi/ordr3.git + # create a virtual environment and install all required dev dependencies cd ordr3 make devenv