Minor touchups to text files. #739
Conversation
Signed-off-by: Pierre Pierre Blais <[email protected]>
| @@ -31,9 +31,9 @@ This is the typical workflow for preparing a pull request. A Github account is r | |||
| 5. Introduce the wanted changes or extensions in your local development environment, see guidelines below. | |||
| If you want change/extend VSS-signals, it is the *.vspec files in the [spec](https://github.com/COVESA/vehicle_signal_specification/tree/master/spec) folder that | |||
| needs to be updated. | |||
| 6. Verify that your changes fulfil VSS Continuous Integration requirements, see [BUILD.md](BUILD.md) for some guidance. | |||
| 6. Verify that your changes fulfill VSS Continuous Integration requirements, see [BUILD.md](BUILD.md) for some guidance. | |||
There was a problem hiding this comment.
Used American spelling as per recommendations.
| @@ -55,7 +55,7 @@ This section includes general guidelines and recommendations for anyone interest | |||
|
|
|||
| COVESA has defined [contribution guidelines](https://www.covesa.global/contribute). | |||
|
|
|||
| Every contribution must carry the following sign-off line with your real name and email address: | |||
| Every contribution (commit) must carry the following sign-off line with your real name and email address: | |||
There was a problem hiding this comment.
Clarified the expectation.
| @@ -82,12 +82,12 @@ Copyright/License-statement may also be added to other files if considered relev | |||
| # SPDX-License-Identifier: MPL-2.0 | |||
|
|
|||
| ``` | |||
| Where XXXX is the year the file was originally created, no need to update or append new years or a range of years later. | |||
| Where {year} is the year the file was originally created. No need to update or append new years or a range of years later. | |||
There was a problem hiding this comment.
There was no XXXX above.
| @@ -0,0 +1,11 @@ | |||
| [[source]] | |||
There was a problem hiding this comment.
Not clear why this was picked up.
There was a problem hiding this comment.
To me it seems that the two Pipfiles were created and added by mistake and can be removed from the PR
There was a problem hiding this comment.
I did not intentionally create these. They were created when I followed the venv installation instructions and ran:
pipenv install --dev
I think that I may have figured out what happened. I was in the vehicle_signal_specification directory instead of vss-tools when I ran the command.
Nonetheless, I don't see Pipfile or Pipfile.lock listed in either .gitignore files.
There was a problem hiding this comment.
I have another commit to remove these files.
There was a problem hiding this comment.
It is indeed a bit unclear in our VSS README where and how to setup the pyenv, it just refers to vss-tools and then it is easy to try to run pyenv from the wrong directory. We could add Pipfile* to .gitignore if we find it useful, our current approach to .gitignore is quite permissive, if anyone wants something to be added because for example their IDE add some files then we accept it.
There was a problem hiding this comment.
I have made a note to add some clarifications.
Now, if I could only sort out how best to do proper squashes, LOL. (The rebase approach I normally use seems to run into issues.)
Signed-off-by: Pierre Pierre Blais <[email protected]>
|
MoM:
|
|
@ppb2020 - Pipfiles are still there, do you have time to fix it or do you want me to remove them as part of merging? |
|
Content merged by #742, thanks for the contribution. |
Read through the .md files and made some minor improvements.