28 general info#39
Conversation
These were discovered during the final stages of reviewing the branch's PR. They were simple enough that they were put off until the next branch.
… license information from top of cpp files.
…iles in the includes/ directory.
…added Jared for his contributions.
Synchronize feature branch
jared321
left a comment
jared321
left a comment
There was a problem hiding this comment.
Please see comments made. Also, we want to see all actions passing before we accept a PR. Right now the spelling action is failing.
https://github.com/bandframework/OpenBT/actions
For information about running the spell checker (and the link checker) locally, please see
https://openbt.readthedocs.io/en/latest/documentation.html#tools
| @@ -3,4 +3,6 @@ Contributing | |||
| General Information | |||
| ------------------- | |||
| .. todo:: | |||
There was a problem hiding this comment.
You should be able to remove .. todo:: now so that this official text is not rendered inside a TODO block.
https://openbt--39.org.readthedocs.build/en/39/contributing.html
Some projects also provide information to potential contributors about what it means to contribute to the project. Some examples
https://github.com/bandframework/Taweret?tab=contributing-ov-file
https://surmise.readthedocs.io/en/latest/contributing.html#developer-s-certificate-of-origin-1-1
| .. _OpenBT repository: https://bitbucket.org/mpratola/openbt/src/master | ||
| .. _OpenBTMixing repository: https://github.com/jcyannotty/OpenBT | ||
|
|
||
| .. todo:: |
There was a problem hiding this comment.
Do you want to handle this TODO as part of this PR?
There was a problem hiding this comment.
What do you want for 'responsibilities of user'?
There was a problem hiding this comment.
Some people like to add an explicit statement about how the code is offered as is and with no guarantees. It's up to the user to determine how to use the software and if the results generated are correct for their purposes. Sometimes this might be referred to as a disclaimer.
https://pages.nist.gov/circular-economy-manufacturing-models/disclaimer.html
You already have something to this effect in the LICENSE.
You will see me add in statements to this effect where I don't want to give people the impression, for example, that just because the test suite is passing that everything must be 100% correct.
https://openbt.readthedocs.io/en/latest/get_started_py.html#testing
There was a problem hiding this comment.
I added a few more things along contributing etc and removed the todo.
… into 28GeneralInfo
2 participants
Added text to contributing.rst and removed incorrect/outdated license information from top of source code files.