diff --git a/README.rst b/README.rst deleted file mode 100644 index e62bde0..0000000 --- a/README.rst +++ /dev/null @@ -1,93 +0,0 @@ - -====== -Twined -====== - -.. image:: https://travis-ci.com/octue/twined.svg?branch=master - :target: https://travis-ci.com/octue/twined - :alt: Build status - -.. image:: https://codecov.io/gh/octue/twined/branch/master/graph/badge.svg - :target: https://codecov.io/gh/octue/twined - :alt: Code coverage - -.. image:: https://readthedocs.org/projects/twined/badge/?version=latest - :target: https://twined.readthedocs.io/en/latest/?badge=latest - :alt: Documentation Status - -.. image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white - :target: https://github.com/pre-commit/pre-commit - :alt: pre-commit - -.. image:: https://img.shields.io/badge/code%20style-black-000000.svg - :target: https://github.com/ambv/black - :alt: Code style - - -**twined** is a library to help digital twins and data services talk to one another. Read more at `twined.readthedocs.io `_. - -Developer notes -=============== - -**You don't need to pay attention to the following unless you plan to develop Twined.** - -Contributing ------------- - -- Please raise an issue on the board (or add your $0.02 to an existing issue) so the maintainers know what's happening and can advise / steer you. -- Create a fork of twined, undertake your changes on a new branch (call it whatever you want). To run tests and make commits, you'll need to do something like: - -.. code-block:: - - git clone # fetches the repo to your local machine - cd twined # move into the repo directory - pyenv virtualenv 3.6.9 twinedenv # Makes a virtual environment for you to install the dev tools into. Use any python >= 3.6 - pyend activate twinedenv # Activates the virtual environment so you don't screw up other installations - pip install -r requirements-dev.txt # Installs the testing and code formatting utilities - pre-commit install # Installs the pre-commit code formatting hooks in the git repo - tox # Runs the tests with coverage. NB you can also just set up pycharm or vscode to run these. - - -- If you don't know what TDD is, go away and find out. We practice TDD here and it'll be glaringly obvious if you don't. - -- Ask the `twined` maintainers *where* to make your pull request. We'll create a version branch, according to the roadmap, into which you can make your PR. We'll help review the changes and improve the PR. - -- Once checks have passed, test coverage of the new code is >=95%, documentation is updated and the Review is passed, we'll merge into the version branch. - -- Once all the roadmapped features for that version are done, we'll release. - - -Release process ---------------- - -The process for creating a new release is as follows: - -1. Check out a branch for the next version, called `vX.Y.Z` -2. Create a Pull Request into the `master` branch. -3. Undertake your changes, committing and pushing to branch `vX.Y.Z` -4. Ensure that documentation is updated to match changes, and increment the changelog. **Pull requests which do not update documentation will be refused.** -5. Ensure that test coverage is sufficient. **Pull requests that decrease test coverage will be refused.** -6. Ensure code meets style guidelines (pre-commit scripts and flake8 tests will fail otherwise) -7. Address Review Comments on the PR -8. Ensure the version in `setup.py` is correct and matches the branch version. -9. Merge to master. Successful test, doc build, flake8 and a new version number will automatically create the release on pypi. -10. Go to code > releases and create a new release on GitHub at the same SHA. - - -Building documents locally --------------------------- - -Install ``doxgen``. On a mac, that's ``brew install doxygen``; other systems may differ. - -Install sphinx and other requirements for building the docs: - -.. code-block:: - - pip install -r docs/requirements.txt - - -Run the build process: - -.. code-block:: - - sphinx-build -b html docs/source docs/build