Skip to content

Latest commit

 

History

History
91 lines (63 loc) · 2.98 KB

CONTRIBUTING.md

File metadata and controls

91 lines (63 loc) · 2.98 KB
Raw

Contributing to objc2

Thank you for your interest in contributing! There are many ways to contribute and we appreciate all of them.

A note for Windows users

This repository relies heavily on symlinks, so make sure that your system is set up to enable those (see this StackOverflow answer for details on how to do that).

Framework crates

objc2 uses a custom tool called header-translator to generate the framework crates. Head over to the README for more detailed instructions on how to use this tool, and generate new bindings.

Note that crates that use CoreFoundation-like functionality is likely to not yet be translatable, see #556 for progress on this front.

git submodules

The framework crates uses a submodule pointing to madsmtm/objc2-generated. This exists to keep the primary repository free from the clutter inherently associated with storing generated files in git, while still allowing change-tracking of said files.

You should consider whether you want a shallow or a full checkout of the generated files - the default is to do a shallow clone, since the repository can become quite large over time.

# Shallow clone
git submodule update --init
# Full clone
git submodule update --init --no-recommend-shallow

See the excellent git documentation on submodules, or the manpage for git-submodule for further details on how submodules work.

Updating the git submodule

When making changes to header-translator, you must update the git submodule manually and push your changes to a fork of objc2-generated (you do not need to submit a PR to that repo).

We try to maintain a linear history in that repo, in a fashion such that every ref that is ever referenced from the HEAD branch in this repository, is reachable from the HEAD branch that repository. This will probably mean you'll have to rebase more often.

If you're confused about this, don't worry too much about it, if you enable "Allow edits by maintainers" we can fix it for you.

Release checklist

Copy and fill out the following checklist into the release PR:

- [ ] The branch is named `ci-full`, such that the full CI will run.
- [ ] Changelogs have only been modified under the `Unreleased` header.
- [ ] Version numbers are bumped in the following order:
    - `objc2-proc-macros`
    - `objc2-exception-helper`
    - `objc2-encode`
    - `objc2`
    - `block2`
    - Framework crates
- Local tests have been run (see `helper-scripts/test-local.fish`):
    - [ ] macOS 10.14.6 32bit
    - [ ] iOS 9.3.6, 1st generation iPad Mini

Post merge:
- [ ] A tag is created on the merge commit for each new version.