Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README for autogenerated subdirectories #49

Merged
merged 1 commit into from
Oct 28, 2021

Conversation

chornge
Copy link
Contributor

@chornge chornge commented Oct 23, 2021

"You must never..." implies a prohibition where doing the opposite would lead to an undesired or unpredictable outcome. That isn't the case here since the changes made to autogenerated subdirectories get overwritten on code regeneration. Also, there's no indication that changes could/would affect SPM builds (which would justify the prohibition).

"You should not..." implies more of a recommendation than a prohibition since it is wasted effort because all changes will be overwritten in order for the package to remain buildable.

Checklist

  • I've read the Contribution Guidelines.
  • My contributions are licensed under the Swift license.
  • I've followed the coding style for the rest of the project.
  • I've updated the documentation if necessary.
  • I've verified that my change does not break any existing tests.
  • I've added tests covering all new code paths my change adds to the project (if appropriate).

• "You must never..." implies a prohibition where doing the opposite would lead to an undesired or unpredictable outcome. That isn't the case here since the changes made to `autogenerated` subdirectories get overwritten on code regeneration. Also, there's no indication that changes could/would affect SPM builds (which would justify the prohibition).

• "You should not..." implies more of a recommendation than a prohibition since it is wasted effort because all changes will be overwritten in order for the package to remain buildable.
@chornge
Copy link
Contributor Author

chornge commented Oct 23, 2021

ADDITIONAL:

In the default checklist template provided, two hyperlinks lead to error screens:
• The Contribution Guidelines hyperlink leads to a "Not Found" screen.
• The Swift license hyperlink leads to "This Page Isn't Working".

I replaced the error links with the following urls:
https://github.com/apple/swift-atomics/blob/919eb1d83e02121cdb434c7bfc1f0c66ef17febe/CONTRIBUTING.md
https://swift.org/LICENSE.txt

@lorentey lorentey merged commit ca13c9b into apple:main Oct 28, 2021
@lorentey lorentey added this to the 1.0.3 milestone Dec 9, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants