Update contribution guide with extra info about Xcode #1772
Conversation
CONTRIBUTING.md
Outdated
| @@ -127,6 +127,10 @@ That will use the version of `web-ext` installed by this project. | |||
| As with the build instructions above, after running `yarn build:safari` you | |||
| should be able to run using Xcode. | |||
|
|
|||
| Note that Xcode will default to signing with Brian Birtles' ([@birtles](https://github.com/birtles)) team. You may need to override the team name to your personal team—however, please don't commit the configuration files this will change to this repo. This is clunky, but unavoidable for open source projects with Xcode. | |||
There was a problem hiding this comment.
Do you remember having to sign up for an Apple Developer Program account for this? It's been such a long time since I was in this situation that I don't recall, but it would be nice to clarify for new contributors whether a personal team requires any extra work.
Link to enroll in the Apple Developer Program, in case it's relevant:
https://developer.apple.com/programs/enroll/
There was a problem hiding this comment.
I already had a Apple Developer Program account beforehand, so I'm not actually sure.
At least for building macOS binaries, I seem to recall that a Developer Program enrollment is required for notarizing, but not for just signing? Not sure if that holds for Safari plugins, though.
CONTRIBUTING.md
Outdated
| @@ -127,6 +127,10 @@ That will use the version of `web-ext` installed by this project. | |||
| As with the build instructions above, after running `yarn build:safari` you | |||
| should be able to run using Xcode. | |||
|
|
|||
| Note that Xcode will default to signing with Brian Birtles' ([@birtles](https://github.com/birtles)) team. You may need to override the team name to your personal team—however, please don't commit the configuration files this will change to this repo. This is clunky, but unavoidable for open source projects with Xcode. | |||
|
|
|||
| Also, if you already have 10ten Japanese Reader installed on your device, you may get signing errors when trying to test the development version. An uninstall and reinstall should fix these. | |||
There was a problem hiding this comment.
Do you recall having to set up Development Provisioning Profiles to deploy to your own device?
If so, worth providing this link:
https://developer.apple.com/help/account/manage-profiles/create-a-development-provisioning-profile/
And worth mentioning that one can develop for Simulator without a provisioning profile at all (I think – do you recall?).
There was a problem hiding this comment.
Do you recall having to set up Development Provisioning Profiles to deploy to your own device?
I don't think so, or at least if I did, I can't remember it 😅.
And worth mentioning that one can develop for Simulator without a provisioning profile at all (I think – do you recall?).
Hmm, I'm thinking I tried that and could not get it to work even on the simulator—however, that could easily just be my own ineptitude with Xcode. Will check this.
There was a problem hiding this comment.
Yep, it does work on a simulator without a profile set. Thanks for pointing that out! Will clarify the info.
|
All good info, thanks! Added some suggestions that may help new contributors further, while we're in the area. |
|
Thanks @StarScape and @shirakaba! |
|
@all-contributors please add @StarScape for docs |
|
I've put up a pull request to add @StarScape! 🎉 |
Just updating the
CONTRIBUTING.mdwith some info that @shirakaba was good enough to help me with a while back. This is probably obvious to anyone who is a competent Apple developer, but was non-obvious to me, so I figure including might help someone else down the line.