Commit Graph

6 Commits

Author SHA1 Message Date
Clark Boylan 12a0aca425 Switch from tox to nox
Recent tox releases have put us on a config treadmill. Avoid these
issues entirely by using nox. Nox is a tox alternative that uses
standard tools like pip and should be simpler to use for us.

Change-Id: Ie79845bbed7ca1254aec466bd5219186fefcdac9
2023-03-13 10:19:07 -07:00
Jeremy Stanley 319953d5ab Overhaul Python package metadata and OpenDev URLs
Modernize our package metadata in the following ways:

* switch from description-file to long_description with the file
  attribute, and specify an explicit content type and encoding

* replace the home-page parameter with the newer general url one

* add specific labelled project links for improved navigation from
  PyPI's summary sidebar

* add commandline keyword to help folks searching

* use the specific license metadata in addition to the corresponding
  trove classifier for it

* make sure wheels when built also incorporate the LICENSE and
  AUTHORS files so that we're not distributing them without a copy
  of the license text

* stop flagging wheels as "universal" now that git-review no longer
  supports Python 2.7

* drop the old Sphinx integration config for PBR now that it's no
  longer needed

https://setuptools.readthedocs.io/en/latest/userguide/declarative_config.html

Also update old openstack.org URLs throughout contributor docs and
examples/comments to newer opendev.org counterparts. Remove the old
redundant HACKING.rst file as well as a lingering MANIFEST.in from
the times before PBR was a thing. Replace the CONTRIBUTING.rst with
a shorter one cribbed from bindep. Add the test profile to the one
entry in bindep.txt to make it more apparent that's not a runtime
dependency of git-review. Adjust some old "OpenStack, LLC."
copyrights as indicated by the foundation's "Legal Issues FAQ."

Change-Id: Ie45d4d73ba7b5a860f09cc4f1d849587761d846c
2021-02-26 20:45:24 +00:00
Adam Spiers 43fcd7f81a Fix complimentary typo
Complimentary means something is free or given as a compliment,
whereas complementary means that it goes well with something else.

https://www.brandtuitive.com/agency-blog/2016/3/29/grammar-matters-complimentary-vs-complementary

Change-Id: I6a1a7db537cc98ea5a93153573a7d6b68eb8aa59
2019-05-28 14:05:49 +01:00
Marc Herbert 5fd2b0c32d CONTRIBUTING.rst, HACKING.rst: fix broken link, minor flow updates
Paraphrasing parts of a private email from Stephen Finucane.

Change-Id: I2b66af40ca16e311bde3b482229ef00b70dcd1f7
2018-12-07 11:23:07 -08:00
Jeremy Stanley c1b6e647d9 Add a note about contribution priorities
It's been poorly documented so far that the current git-review
maintainers are avoiding addition of new features. Gerrit-based
change workflows are already confusing enough to new users, and
providing them with too many complex options risks making things
worse. This tool's goal is to do a few things well and simply in
support of an opinionated workflow, without becoming everything to
everyone.

Since git-review sees broad usage outside the OpenStack contributor
community, it is subject to a lot of drive-by feature additions. Add
a note to the contributing document indicating its maintainers
consider it to be mostly complete (modulo bug fixes, compatibility
improvements, adding test coverage), so that readers will consider
strongly whether their particular improvement is well suited to the
existing scope of the tool.

Change-Id: I11b9f898286b75177493af31e209c2853d78f245
2017-11-17 03:46:01 +00:00
Doug Hellmann b6aab6d9d6 Split README.rst into separate doc files
Split up the README into separate documentation files so we can publish
the documentation for git-review.

Change-Id: Idcdf43e73c5ca5b8cb239606236e3b2a660c46b7
2015-02-03 17:38:50 +01:00