Labels

We use "labels" in the issue tracker to help classify pull requests and issues. Using labels enables maintainers and users to quickly find issues they should look into, either because they experience them, or because it meets their area of expertise.

Explanations

If you are unsure what a label is about or which labels you should apply to a PR or issue, look no further!

Techonology Related

• ports:
  • arm has to do with the ARM family of boards and processors
  • avr has to do with the AVR family of boards and processors
  • msp has to do with the MSP family of boards and processors
  • native has to do with the native family of boards and processors (i.e. the emulator)
  • x86 has to do with the X86 family of boards and processors
• modules:
  • core something about the RIOT kernel core (i.e. anything in /core)
  • network any part of the network code
  • tests something with either the test applications or the unittests (i.e. anything in /tests)
  • posix concerns the POSIX support RIOT
  • pkg is anything in the /pkg directory
• C++ concerning the c++ support in RIOT
• make the build system is concerned
• osx only concerns MAC OS X users (tends to be a complicated platform)
• windows only concerns Windows users

Universal Classification

• api change this will need user code changes
• bug this issue/PR is about an error
• cleanup a refactoring, tidying up, dead code removal, ... issue/PR
• documentation has to do with documentation - API, wiki or internal
• enhancement this issue/PR is about the extension of existing functionality
• major some "big" or "complicated" thing, possibly API changing
• minor some little thing - does not change the API, should be easy to review/implement
• new feature issue/PR is about a new feature, i.e. functionality that does not exist already
• question a question issue (this is a convenience feature for people who don't like IRC and mailing lists)
• duplicate there exists another issue/PR on the same subject

Process Related

• NEEDS SQUASHING the commits in this PR should be sqashed prior to merging
• Newbie-Task-Candidate a good task if you're new to RIOT - not too complicated, might give you an insight
• Request for Comments a draft PR or brain storming issue - should encourage others to provide input
• WIP (Work In Progress) unfinished PR - might be interesting to look into if you need the feature/issue it implements/fixes
• Waiting For Other PR - depends on a different PR (should be mentioned in the PR description), can be merged only after the other PR has been merged
• Ready for CI build enables the CI to perform compile tests
• backporting-needed - a PR with this label set signals that it contains a bug fix for an issue also present in the latest supported release and should be backported to the corresponding release branch
• *TF - labels ending in TF belong to a certain Task Force
• Labels applied to closed but possibly relevant issues (so you might want to look for those):
  • memo the issue/PR will not be fixed/finished now, might be useful for reference
  • wontfix the issue will most likely never be fixed
  • invalid a non-issue, might contain an explanation of what went wrong in case you stumble upon the same issue

Assorted

• PR-award-nominee a PR that is noteworthy and deserves an award
• Artificial labels introduced by huboard (warning: site is quite slow)
  • 0 - Backlog
  • 1 - Ready
  • 2 - Working
  • 3 - Done