Skip to content

Developer Information

Jump to bottom
Tom Ludwig edited this page Oct 31, 2024 · 2 revisions

How to Develop CodeEditSourceEditor Locally

There are two options for developing CodeEditSourceEditor locally:

Option 1: Open the Package in Xcode

  1. Open the CodeEditSourceEditor package in Xcode.
  2. Note that while you can modify the code, you won’t be able to see the results directly. This is usually a good way for quick changes and running tests.

Option 2: Use the Example Project (preferred)

  1. Open Finder and navigate to the CodeEditSourceEditor folder.
  2. Locate and open the Example folder.
  3. Double-click on the CodeEditSourceEditorExample.xcproject file to open it in Xcode.
  4. Run the example project with your local changes, allowing you to quickly see your progress in action.

Note

Note: Please run the tests and check SwiftLint before requesting a review on your pull requests (PRs). Doing this will save both you and the reviewers a lot of time.

Before You Contribute

Of course, you are free to work on any issue you’d like. However, it would be appreciated if you could first ask to be assigned to an issue. If there isn’t an existing issue for your specific concern, please go ahead and create one.

Then, ping one of the maintainers. They can help you with the issue or let you know if it’s not planned or if it should be postponed until a related feature is merged. Whatever the situation, they will assist you and likely save you time.

Please also: Please read the issue description closely. And if you resolve an issue, remember to mark it as closed in your pull request description, or at least mention it.

Clone this wiki locally