Updating common.rst#15
Conversation
Updated common.rst with newest instructions about git, versioning and other small information. Also, I'm moving versioneer under python, as it not general enough.
| Furthermore, we will provide configuration files for most linters and | ||
| formatter, so that you can easily setup your editor and to automatically | ||
| format your code to the style guidelines. |
There was a problem hiding this comment.
Such promises for the future are not really helpful. It might be good here to say "find config files on this wiki page ", and start that wiki page, and put things on there (whatever you have so far).
| Do not add temporary files, data files, backup files, or compilation products | ||
| to a repository! When preparing to commit code, run ``git status`` frequently | ||
| to see what files are present, modified, and staged for commit. Commands like | ||
| ``git add *`` and ``git commit -a`` should not be used and are higly |
| <https://git-scm.com/docs/gitignore>`__. Note that github makes | ||
| `templates <https://github.com/github/gitignore>`__ available for many | ||
| different programmaing languages. | ||
| documentation on the `.gitingore file`_. Note that github makes |
There was a problem hiding this comment.
gitignore, not gitingore! my bad :)
| `templates <https://github.com/github/gitignore>`__ available for many | ||
| different programmaing languages. | ||
| documentation on the `.gitingore file`_. Note that github makes | ||
| `templates`_ available for many different programmaing languages. |
| new features or fix a significant number of issues to the code, without | ||
| changing the API. In the case of releases that are primarily bug fixes or | ||
| rolling releases, the patch version z should be incremented. | ||
|
|
There was a problem hiding this comment.
Maybe at least mention some tools that are used to record and expose version numbers? In SO we lean into the github release feature, and versioneer, right?
There was a problem hiding this comment.
Okay, I will add that we lean in the Github release feature, but I am moving versioneer under python. I have added a similar tool under the C++ part of the docs if you see #14 again.
There was a problem hiding this comment.
For what it's worth I've moved away from versioneer in the packages I manage. It only supports setuptools as a build backend -- and a while back setuptools made some breaking changes that annoyed me enough to switch to something more modern (I chose hatchling). I'm using hatch-vcs now in place of versioneer.
There was a problem hiding this comment.
Personally I would stay away from auto-versioning tools... "Not having to think about what version this is" causes more problems than it's worth.
There was a problem hiding this comment.
I also use setuptools-scm instead of versioneer.
There was a problem hiding this comment.
Great, in the appropriate sections just suggest one or more good options (including something simple). The point is to point people in the right direction and discourage wheel-reinvention / rabbit-hole-excursion.
4 participants
I updated common section to be a bit more general. Parts that where python specific will move there for correctness and completeness.
I also updated how pages are linked and referenced to be in a more RST style.
Depends on #14 to fix the errors.