Cookierelease: Folder setup 1/3 (Excluding src and doc) #7
Conversation
There was a problem hiding this comment.
@sbillinge Please review.
Unnecessary files will be also removed in the upcoming PRs.
LICENSE.rst
Outdated
| @@ -0,0 +1,30 @@ | |||
| BSD 3-Clause License | |||
|
|
|||
| Copyright (c) 2009-2024, The Trustees of Columbia University | |||
There was a problem hiding this comment.
I think this work does not go back to 2009
| Contact | ||
| ------- | ||
|
|
||
| For more information on diffpy.nmf_mapping please visit the project `web-page <https://diffpy.github.io/>`_ or email Prof. Simon Billinge at sb2896@columbia.edu. |
There was a problem hiding this comment.
diffpy.nmf_mapping configured correctly.
|
Looks good. Just some issues with copyright dates maybe? |
I see the first commit being 2022. I will make a change. |
bobleesj
left a comment
bobleesj
left a comment
There was a problem hiding this comment.
Please check the new copyright years
README.rst
Outdated
|
|
||
| If you use diffpy.nmf_mapping in a scientific publication, we would like you to cite this package as | ||
|
|
||
| diffpy.nmf_mapping Package, https://github.com/diffpy/diffpy.nmf_mapping |
There was a problem hiding this comment.
I think there is a paper/papers that need citing for this one. Also in the docs
There was a problem hiding this comment.
Fixed in REAMDE.rst. I will add citations to docs in the following PRs where I move from docs to doc using git mv. @sbillinge
There was a problem hiding this comment.
I see the citation format, in diffpy.structure and diffpy.pdffit2. I will make a change.
|
@sbillinge I also have a general question on a GH workflow. Assume I made a mistake in a commit, and I want to revert my commit (to fix the problem). I also do not want the reviewer to waste time reading the mistake. I see some options such as 1) force push 2) git revert. I see that What is the best practice? |
|
Please review: Citations added to 
|
Nice job. For the second paper add the words "and please consider citing " before it. |
Yup. Added. I will reflect those in 
|
never force push. I don't want to merge any force-pushes. Some repo's have this set as a rule. just revert if it is a small commit. The revert applies the anti-change, so the change is done then undone, which is ok if it is small, but if it is big it is generally better to kill the branch and do a new PR. Again, another reason to keep the edits on each PR to be small. |
Thank you. Well noted. @sbillinge |
2 participants
Please review. @sbillinge
src/anddoc/will be handled in the next PRs.