From afdfb49d0128837337f0df6e77ce62dbc2935368 Mon Sep 17 00:00:00 2001 From: Jens Nistler Date: Thu, 27 Jun 2024 15:27:30 +0200 Subject: [PATCH] change docs to markdown --- AUTHORS.md | 6 +++ AUTHORS.rst | 14 ------ CONTRIBUTING.rst | 110 ----------------------------------------------- MANIFEST.in | 9 ++-- setup.py | 2 +- 5 files changed, 11 insertions(+), 130 deletions(-) create mode 100644 AUTHORS.md delete mode 100644 AUTHORS.rst delete mode 100644 CONTRIBUTING.rst diff --git a/AUTHORS.md b/AUTHORS.md new file mode 100644 index 0000000..4c21614 --- /dev/null +++ b/AUTHORS.md @@ -0,0 +1,6 @@ +# Credits + +## Contributors + +* [Jens Nistler](https://github.com/lociii) +* [Mounir Messelmeni](https://github.com/mounirmesselmeni) diff --git a/AUTHORS.rst b/AUTHORS.rst deleted file mode 100644 index dc0b81c..0000000 --- a/AUTHORS.rst +++ /dev/null @@ -1,14 +0,0 @@ -======= -Credits -======= - -Development Lead ----------------- - -* Jens Nistler -* Mounir Messelmeni - -Contributors ------------- - -None yet. Why not be the first? diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst deleted file mode 100644 index 304e739..0000000 --- a/CONTRIBUTING.rst +++ /dev/null @@ -1,110 +0,0 @@ -.. highlight:: shell - -============ -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/RegioHelden/django-languageselect/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" -and "help wanted" is open to whoever wants to implement it. - -Implement Features -~~~~~~~~~~~~~~~~~~ - -Look through the GitHub issues for features. Anything tagged with "enhancement" -and "help wanted" is open to whoever wants to implement it. - -Write Documentation -~~~~~~~~~~~~~~~~~~~ - -django_languageselect could always use more documentation, whether as part of the -README, 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/RegioHelden/django-languageselect/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. -* Remember that this is a volunteer-driven project, and that contributions - are welcome :) - -Get Started! ------------- - -Ready to contribute? Here's how to set up `django_languageselect` for local development. - -1. Fork the `django_languageselect` repo on GitHub. -2. Clone your fork locally:: - - $ git clone git@github.com:your_name_here/django_languageselect.git - -3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:: - - $ mkvirtualenv django_languageselect - $ cd django_languageselect/ - $ python setup.py develop - -4. Create a branch for local development:: - - $ 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 flake8 and the tests, including testing other Python versions with tox:: - - $ flake8 django_languageselect tests - $ python setup.py test or py.test - $ tox - - To get flake8 and tox, just pip install them into your virtualenv. - -6. Commit your changes and push your branch to GitHub:: - - $ 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 README should be updated.. -3. The PR must pass the CI tests. - -Tips ----- - -To run a subset of tests:: - -```bash - python -m unittest tests.test_django_languageselect -``` diff --git a/MANIFEST.in b/MANIFEST.in index 2d317b9..6b2a342 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,8 +1,7 @@ -include AUTHORS.rst -include CONTRIBUTING.rst -include HISTORY.rst +include AUTHORS.md +include HISTORY.md include LICENSE -include README.rst +include README.md recursive-include tests * recursive-include django_languageselect/templates * @@ -10,4 +9,4 @@ recursive-include django_languageselect/templatetags * recursive-exclude * __pycache__ recursive-exclude * *.py[co] -recursive-include docs *.rst conf.py Makefile make.bat *.jpg *.png *.gif +recursive-include docs *.md conf.py Makefile make.bat *.jpg *.png *.gif diff --git a/setup.py b/setup.py index f58a8a5..3911d44 100644 --- a/setup.py +++ b/setup.py @@ -21,7 +21,7 @@ def get_version(*file_paths): with open('README.md') as readme_file: readme = readme_file.read() -with open('HISTORY.rst') as history_file: +with open('HISTORY.md') as history_file: history = history_file.read() requirements = [