Skip to content

Latest commit

 

History

History
96 lines (65 loc) · 3.25 KB

CONTRIBUTING.md

File metadata and controls

96 lines (65 loc) · 3.25 KB
Raw

Contributing to Picolibc

We welcome contributions of all forms, including patches to code and documentation, issue reports, or just kind words.

Getting Current Source Code

Picolibc sources are maintained in git and hosted in two places.

  1. keithp.com. This is the 'canonical' source location.

  2. github. This should exactly mirror the code at keithp.com. I've placed it here to make contributing to Picolibc easier for people familiar with github.

You can create a local copy of the repository with git clone:

$ git clone git://keithp.com/git/picolibc.git

or

$ git clone https://github.com/keith-packard/picolibc.git

Meson

Picolibc uses the meson build tool. You'll need to make sure that's installed before you start trying to build the software.

Building Picolibc from Source

As Picolibc is designed to be used for embedded systems, getting that configured correctly can be a challenge. Learn more about that in the build page.

Formatting Source Code

Picolibc code comes from a multitude of sources using an enormous range of styles. As picolibc tries to retain compatibility with newlib so that bug fixes can be shared between projects, we can't easily reformat all of the existing code. Here are suggestions on how to preserve compatibility while still being able to write readable code:

  1. Whitespace-only changes are not helpful, please don't submit changes that are only fixing formatting.

  2. Try to adopt local coding styles as much as you can manage by matching code within the same files.

  3. For brand-new files, please use the global .editorconfig settings if possible:

    • no literal tab characters, only spaces
    • 4-space indentation for nested elements
    • no trailing whitespace
    • utf-8 encoding

Patch Submission

You can submit patches in a couple of ways:

  1. Mail to the picolibc list (see below). This can be tricky as it requires a friendly email system, and you'll have to subscribe to the mailing list before it will let you post anything (sigh). Here's a simple example sending the latest patch in your local repository to the list:

    $ git send-email --to [email protected] HEAD^

  2. Generate a pull-request in github.

    1. Fork the picolibc project into your own github account
    2. Push patches to that repository
    3. While viewing your repository, click on the 'New pull request' button and follow the instructions there.

Issue Tracking

We're using the issue tracker on Github for now; if you have issues, please submit them to the Picolibc Issue Tracker

Mailing List

Picolibc has a mailing list, hosted at keithp.com. You can subscribe here. This is a public list, with public archives. Participants are expected to abide by the Picolibc Code of Conduct.

Code of Conduct

Picolibc uses the Contributor Covenant, which you'll find in the source tree as CODE_OF_CONDUCT.md. Please help make picolibc a kind and welcoming environment by following those rules.