search

NWChemEx / .github

GitHub Settings for the NWChemEx Organization
https://nwchemex.github.io/.github/
Apache License 2.0
1 stars 2 forks source link

Automated Licensing Documentation #47

Closed quazirafi closed 2 years ago

quazirafi commented 2 years ago
  1. Added instructions for developers to add license headers automatically to the source programs file of newly created repositories.
  2. Also, added the list of repos that follow the 4-layered CI Architecture.
hjjvandam commented 2 years ago

Overall this looks good. I have a few minor points though (going sequentially through the text from beginning to end):

Otherwise this is very nice.

quazirafi commented 2 years ago

Overall, looks good, just needs a couple of simple mods.

Need to spell workflow correctly (currently at least one instance of wrokflow).

Change "Everything will remain same" to "Everything will remain the same"

@hjjvandam will change those! Thanks!

quazirafi commented 2 years ago

Overall, looks good, just needs a couple of simple mods.

Need to spell workflow correctly (currently at least one instance of wrokflow).

Change "Everything will remain same" to "Everything will remain the same"

Sorry for the spelling! Will fix that! Thanks! @twindus

quazirafi commented 2 years ago

Overall this looks good. I have a few minor points though (going sequentially through the text from beginning to end):

  • Instead of "all our source codes" I think "all our source code" is better.
  • I guess the path ".github/.github/workflows/add_licenses_master.yaml" contains a ".github" too many.
  • Instead of "You may recall that it is" I think "You may recall that this is" is more natural English.
  • Instead of "You do not need to do any change" I would write "You do not need to make any changes".
  • I would write "file from the NWChemEx repository" instead of "file from NWChemEx repository".
  • The "wrokflow" was mentioned by Theresa already.
  • Again, I would add "the" before NWChemEx in ".licenserc.yaml file from NWChemEx".
  • Instead of "may cause error." I would write "may cause errors."
  • I would replace "all source codes in the repo" with "all source files in the repo" which is a little bit clearer in this context, I think.

Otherwise this is very nice.

@hjjvandam

  1. Fixed
  2. Actually, it is correct I suppose. .github is the name of the repository. Then we have the workflow files inside of the .github/workflows directory inside of the .github repository. Screen Shot 2022-09-16 at 3 45 52 PM
  3. Fixed
  4. Fixed
  5. Fixed
  6. Fixed
  7. Fixed
  8. Fixed
  9. Fixed
quazirafi commented 2 years ago

Overall, looks good, just needs a couple of simple mods.

Need to spell workflow correctly (currently at least one instance of wrokflow).

Change "Everything will remain same" to "Everything will remain the same"

@twindus fixed!