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

File Template with Copyright Header #408

Merged
merged 1 commit into from
Mar 30, 2024

Conversation

Jag-Marcel
Copy link
Member

Contributor checklist


Description

This adds a template to a new directory called ScribeTemplates, which adds the copyright notice used in #403 to any newly created file using said template. You would find it when creating a new file in Xcode, where you would scroll to the bottom and select the template in a new category called "ScribeTemplates".
To use this template, you would first have to add it to your own Xcode templates by:

  1. Creating a "Templates" directory in your Xcode folder (found at Users/[your username]/Library/Developer/Xcode)
  2. Symlink the Scribe template into "Templates"

Using commands:

mkdir ~/Library/Developer/Xcode/Templates
ln -s [Path to your Scribe directory]/Scribe-iOS/ScribeTemplates ~/Library/Developer/Xcode/Templates/

Related issue

The template would be shown when scrolling to the bottom in the file creation menu, in a new category called "ScribeTemplates"
Copy link

github-actions bot commented Mar 18, 2024

Thank you for the pull request!

The Scribe team will do our best to address your contribution as soon as we can. The following is a checklist for maintainers to make sure this process goes as well as possible. Feel free to address the points below yourself in further commits if you realize that actions are needed :)

If you're not already a member of our public Matrix community, please consider joining! We'd suggest using Element as your Matrix client, and definitely join the General and iOS rooms once you're in. It'd be great to have you!

Maintainer checklist

  • The commit messages for the remote branch should be checked to make sure the contributor's email is set up correctly so that they receive credit for their contribution

    • The contributor's name and icon in remote commits should be the same as what appears in the PR
    • If there's a mismatch, the contributor needs to make sure that the email they use for GitHub matches what they have for git config user.email in their local Scribe-iOS repo
  • The CHANGELOG has been updated with a description of the changes for the upcoming release and the corresponding issue (if necessary)

@Jag-Marcel
Copy link
Member Author

I don't know if there is a way to create the link automatically when cloning / running the project for the first time, otherwise we'd have to add a note about this to README.md

@andrewtavis andrewtavis self-requested a review March 29, 2024 23:58
Copy link
Member

@andrewtavis andrewtavis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this, @Jag-Marcel! I really wish this was something simpler for people to just add to a config file. Makes sense to bring this in though, and I'll add a note about it to the contributing guide (I think it might be confusing in the readme). Appreciate the research!

@andrewtavis andrewtavis merged commit 7de118f into scribe-org:main Mar 30, 2024
1 check passed
@Jag-Marcel Jag-Marcel deleted the copyright-template branch July 11, 2024 15:54
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.

2 participants