PR Submission Guidelines

[tgross35]

When you submit a PR, please follow these guidelines to give your PR the best chance of being accepted:

1. All new API should be added to libc-test/semver, which makes sure it doesn't get removed in the future.

2. All changes must have permalink to headers in commit messages. See Source links below for more details.

3. For any constants that are expected to change, e.g. *LAST or *MAX, try to add the following doc comment:

   /// Constants may change across releases. See the [usage guidelines](crate#usage-guidelines)
   /// for details.
   

4. Tested locally (cd libc-test && cargo test --target mytarget) especially relevant for platforms that may not be checked in CI

Source links

Please include permalinks to headers in commit messages for all API changes. Common sources include:

• Linux uapi https://github.com/torvalds/linux/tree/master/include/uapi
• Glibc https://sourceware.org/git/?p=glibc.git;a=tree
• Musl https://github.com/kraj/musl (original is https://git.musl-libc.org/cgit/musl/tree/)
• Apple XNU https://github.com/apple-oss-distributions/xnu, libc https://github.com/apple-oss-distributions/Libc/tree/main/include
• Android https://cs.android.com/android/platform/superproject/main
• FreeBSD https://github.com/freebsd/freebsd-src/tree/main/lib/libc
• Illumos https://github.com/illumos/illumos-gate/tree/master/usr/src/lib/libc

After navigating to the relevant file, click the triple dots and select "copy permalink" if on GitHub, or l-r (links->commit) for the Android source to get a link to the current version of the header.

If sources are closed, link to documentation or paste relevant C definitions.

(The PR description is fine too, commit messages are preferred because they become part of history)

[tgross35]

Moved to CONTRIBUTING.md in #5291.