Convert to markdown (fixes zostera#220) (zostera#219)

- Convert HISTORY.rst to Markdown and rename to CHANGELOG.md.
- Convert README.rst, AUTHORS.rst and CONTRIBUTING.rst to Markdown, and change extension to .md.
- Update CONTRIBUTING.md to reflect use of `poetry`.
- Remove contributing.rst from docs

AUTHORS.md

@@ -0,0 +1,25 @@
+# Authors
+
+This application is developed and maintained by [Zostera](https://zostera.nl).
+
+## Development Lead
+
+- Dylan Verheul <[email protected]>
+
+## Contributors
+
+- Allard Stijnman <[email protected]>
+- Austin Whittier <[email protected]>
+- Caio Ariede <[email protected]>
+- Fabio C. Barrionuevo da Luz <[email protected]>
+- Fabio Perfetti <[email protected]>
+- Jay Pipes <[email protected]>
+- Jonas Hagstedt <[email protected]>
+- Jordan Starcher <[email protected]>
+- Juan Carlos <[email protected]>
+- Markus Holtermann <[email protected]>
+- Nick S <[email protected]>
+- Owais Lone <[email protected]>
+- pmav99 <[email protected]>
+- Richard Hajdu <[email protected]>
+- Timothy Allen <[email protected]>

CHANGELOG.md

@@ -0,0 +1,121 @@
+# Changelog
+
+## Unreleased
+
+- Convert HISTORY.rst to Markdown and rename to CHANGELOG.md.
+- Convert README.rst, AUTHORS.rst and CONTRIBUTING.rst to Markdown, and change extension to .md.
+- Update CONTRIBUTING.md to reflect use of `poetry`.
+
+## [2.0.1] - (2020-06-02)
+
+- Set beautifulsoup4 requirement to \>= 4.8.0 (fixes #216).
+- Do not assume all inputs are inside labels (fixes #215).
+
+## [2.0.0] - (2020-06-01)
+
+- Use poetry (<https://python-poetry.org/>) for dependency management and packaging.
+- Drop support for Python 3.5.
+- Fix form-check-{label,input} classes applied too broadly. These should only be applied to labels and inputs found underneath the enclosing widget div for radio and checkbox select, not on the whole document.
+- Allow to display radio and checkbox elements inline using the `form-check` classes.
+
+## [1.1.2] - (2019-12-13)
+
+- Restructure tox and Makefile.
+- Add test for `bootstrap4.__version__`.
+
+## [1.1.1] - (2019-12-11)
+
+- Remove tag command from Makefile.
+- Reinstate `bootstrap4.__version__` (#186).
+- Add test for using a different jQuery version (#184).
+
+## [1.1.0] - (2019-12-09)
+
+- Update default Bootstrap to v4.3.1.
+- Add support for Python 3.8, Django 3 and Django master.
+- Switch to Django `manage.py` for test running.
+- Update Makefile commands.
+- Update tox configuration.
+- Use correct license (BSD-3-Clause).
+- Fix typo's in docstrings.
+- Update Travis configuration.
+- Drop MANIFEST.in, use `setuptools_scm`.
+- Stop using `_version.py`, use git tags for versioning.
+- Fixed issues with labels and input (#174 and #181).
+
+## [1.0.1] - (2019-08-30)
+
+- Fix support for Python 3.5 (#168).
+- Set correct Python versions in setup.py.
+- Fix `make test` command.
+
+## [1.0.0] - (2019-08-30)
+
+- Set default class for buttons to `btn-primary` (#150.
+- Drop support for Python 2 and Django 1.11, 2.0 and 2.1 (#155).
+- Template tag `bootstrap_field` now allows 3 values for `show_label`: `True`, `False`, `sr-only` and `skip\`. In the case of `False` / `sr-only` the label is hidden but present for screen readers. When `show_label` is set to `skip`, the label is not generated at all.
+- Fix validation on input groups (#122).
+- No longer duplicate jquery in bootstrap4.html (#139, #140).
+- Apply `form-check`, `form-check-label` and `form-check-input` classes to appropriate tags for `RadioSelect` and `CheckboxSelectMultiple` widgets (#141).
+- Errors on file inputs are shown (#146).
+- Only display non-field errors in form alert block (#161).
+- Reinstate `bootstrap4_title` block to `bootstrap4.html` (#156).
+- Fix typo in `alert-dismissible` class (#142).
+- Honor the `form_group_class` parameter in the `buttons` tag (#162).
+
+## [0.0.8] - (2019-03-12)
+
+- Drop support for the `base_url` setting (#105).
+- Remove use of \"falsy\" as a string literal (#111).
+- Fix javascript inclusion bugs (#71).
+- Allow email to have addons (#131).
+- Do not mark placeholder text as safe (#135).
+
+## [0.0.7] - (2018-08-22)
+
+- Improve alert accessibility (#93.
+- Add a new widget: RadioSelectButtonGroup (#103.
+- Several fixes and improvements to HTML renderin.
+- Switch to explicit Travis test.
+- Upgrade Bootstrap to 4.1.1
+- Upgrade jQuery to 3.3.1
+- Upgrade Popper to 1.14.3
+- Fixed `bootstrap4.html` to add jQuery per setting `include_jquery=[False|'full'|'slim']`.
+- Adopt Black formatting, see <https://github.com/ambv/black>.
+
+## [0.0.6] - (2018-02-14)
+
+- Change form help text element from div to small (#60).
+- Upgrade Bootstrap to 4.0.0 (#66).
+
+## [0.0.5] - (2018-01-03)
+
+- Drop develop branch, work with master and feature branche.
+- Clean up `HISTORY.rst`.
+- Upgrade Bootstrap to 4.0.0-beta.3.
+- Use `col-4` rather than `col-xs-4` (#54).
+- Added pagination alignment options (#56).
+- Fixed form field errors and help texts (#39.
+- Use django language if `USE_I18N=True` (#53).
+
+## [0.0.4] - (2017-10-26)
+
+- Upgrade Bootstrap to 4.0.0-beta.2.
+- Fix settings, tags and tests for remote JS and CSS.
+
+## [0.0.3] - (2017-09-24)
+
+- Upgraded bootstrap4 to the beta version.
+
+## [0.0.2] - (2017-09-06, not released on PyPI)
+
+- Upgraded jQuery version from CDN to 3.2.1 (#17).
+- Added proper pagination layout classes (#19).
+
+## [0.0.1] - (2017-06-04)
+
+- First releas.
+- Remove `bootstrap_icon`, BS4 no longer has default icons.
+- Various changes to get from 3 to 4, started MIGRATE.rst.
+- Started `django-bootstrap4` based on `django-bootstrap3`.
+- Thanks everybody that contributed to `django-bootstrap3`!

CONTRIBUTING.md

@@ -0,0 +1,82 @@
+# Contributing
+
+Contributions are welcome, and they are greatly appreciated! Every
+little bit helps, and credit will always be given.
+
+You can contribute in many ways:
+
+## Types of Contributions
+
+### Report Bugs
+
+Report bugs at <https://github.com/zostera/django-bootstrap4/issues>.
+
+If you are reporting a bug, please include:
+
+- Your operating system name and version.
+- Any details about your local setup that might be helpful in troubleshooting.
+- Detailed steps to reproduce the bug.
+
+### Fix Bugs
+
+Look through the GitHub issues for bugs. Anything tagged with \"bug\" is open to whoever wants to implement it.
+
+### Implement Features
+
+Look through the GitHub issues for features. Anything tagged with \"feature\" is open to whoever wants to implement it.
+
+### Write Documentation
+
+`django-bootstrap4` could always use more documentation, whether as part of the official django-bootstrap4 docs, in docstrings, or even on the web in blog posts, articles, and such.
+
+### Submit Feedback
+
+The best way to send feedback is to file an issue at
+<https://github.com/zostera/django-bootstrap4/issues>.
+
+If you are proposing a feature:
+
+- Explain in detail how it would work.
+- Keep the scope as narrow as possible, to make it easier to implement.
+
+## Get Started!
+
+Ready to contribute? Here\'s how to set up `django-bootstrap4` for local development.
+
+You will need some knowledge of git, github, and Python/Django development. Using a Python virtual environment is advised.
+
+1. Fork and clone `django-bootstrap4` repo on GitHub. There is an excellent guide at <https://guides.github.com/activities/forking/>.
+2. Install [poetry](https://python-poetry.org).
+3. Inside your local `django-bootstrap4` folder, run
+    ```shell script
+    $ poetry install
+    ```
+4. Create a branch for local development:
+    ```shell script
+    $ git checkout -b name-of-your-bugfix-or-feature
+    ```
+    Now you can make your changes locally.
+5. When you\'re done making changes, check that your changes pass the tests.
+    Run the unit tests in your virtual environment with the `manage.py` command:
+    ```shell script
+    $ python manage.py test
+    ````
+    Run the extended tests with `tox`:
+    ```shell script
+    $ make tox
+    ```
+6. Commit your changes and push your branch to GitHub:
+    ```shell script
+    $ git add .
+    $ git commit -m "Your detailed description of your changes."
+    $ git push origin name-of-your-bugfix-or-feature
+    ```
+7. Submit a pull request through the GitHub website.
+
+## 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 CHANGELOG.md.
+3. The pull request should pass the Continuous Integration tests. Check <https://travis-ci.org/zostera/django-bootstrap4/pull_requests> and make sure that all tests pass. You can run the tests locally using `tox`.