Community

Code of Conduct

In the interest of fostering an open and welcoming environment, we as contributors and maintainers have adopted the Code of Conduct from the Contributor Covenant. We pledge to make participation in our project and our community a harassment-free experience for everyone. This Code of Conduct applies equally to all community participants and to all spaces the project manages or authorizes (ie. IRC channels, the mailing lists, issue trackers, sponsored events, and any other forums the community uses and the project manages). Violations of this code of conduct in or outside the project space might affect your ability to participate in the community after appropriate investigation. See our full Code of Conduct pledge.

How to Contribute

Thanks for your interest in contributing to the community. Intel is responsible for the product management and the core stack of Celadon, so all contributions go through a review and verification process in order to determine fit and maintain quality. We try our best to include all contributions.

Note on Jira: We use Open Jira for tracking contributions and bugs. You need to have a 01.org account to track or file a change for Celadon. 01.org is home to Intel’s open source initiatives and communities. It also has an account facility that is used to provide accounts for our open source bug tracking instance at 01.org/jira. Once you register for an account, you can log into 01.org/jira to track or report issues.

Steps to contribute:

  1. ​​​​Go to Jira. Select project "Celadon". Search to see if your request has already been made.
  2. Create a new Jira ticket under the appropriate project "Celadon" if the request was not found. Fill in the mandatory fields as well as any other fields that you think are relevant and might be helpful to know. You link to this Jira ticket in Step 5.
  3. Go to GitHub and create a fork request on the repository where you would like to provide your patch/fix and clone the fork repository (developer branch repository) to your local setup.
  4. Make your changes into your local setup and add to your fork branch. 
    • Example: git add filename.cpp
  5. Commit your changes into your local setup. Include the following in the commit message body:
    • Summary of the contribution patch.
    • Detailed description about the patch:
      • What does the change do?
      • Why are you choosing this approach?
      • What assumptions are you making?
      • What tests were run and which do you expect to pass?
    • Link to the Jira ticket created in Step 2
    • Signed-off-by: <your name><email> 
  6. Push your changes to your fork GitHub branch (developer branch repository).
    • Example: git push
  7. Go to your fork repository as created in Step 3 and send in a “New pull request” to request the Maintainer/Reviewer to review/merge your fork branch changes to the Celadon master branch. This will automatically assign the assigned Maintainer to review your changes. 
  8. You can further discuss your patch with the Maintainer in the comment section of “New pull request”, though the mailing list, or on IRC.
  9. The Maintainer merges your patch to master branch after review.

Note: Tracking temporary patches:

If the commit is a workaround for a known issue, which needs more time to be properly fixed, the commit needs a tag: "REVERT-ME: Summary of the workaround"

Note: Changes spawning multiple repos

Feature changes can spawn across multiple repositories. In that case, use the actual feature enabling change as the main pull request and list down all dependent pull requests for the other repos so that the complete context is provided in one place. This will allow for easy review of all related changes in the given context and shows that these pull requests might need to merge at the same time.

 

Report a Bug or Issue

Thanks for helping to improve Celadon, We try our best to prioritize fixes into a release. 

Note on Jira: We use Open Jira for tracking contributions and bugs. You need to have a 01.org account to track or file a change for Celadon. 01.org is home to Intel’s open source initiatives and communities. It also has an account facility that is used to provide accounts for our open source bug tracking instance at 01.org/jira. Once you register for an account, you can log into 01.org/jira to track or report issues.

Steps to report an issue:

  1. See all open issues by logging into Jira using your 01.org username. Select project "Celadon" and search to see if issues have already been reported. 
  2. If you don’t find the issue already reported, please select Create to file the issue under project “Celadon”. If there are multiple issues, please separate them into separate bug reports and file them individually. 
  3. Fill in all the mandatory fields. 

For Summary field, please provide information using this format:

[Component/Test][PLATFORM] <Error Type there is any> with <bug phenomenon and Impact> + <detailed info about the test if there is any>

Example:  "[Camera] [KBL NUC]The sound of recorded video is low and hard to hear"

For Description field, please provide as much information as possible related to the issue or bug including: 

  • Issue summary
  • Build version
  • Pre-conditions
  • Steps to reproduce
  • Expected test result
  • Actual test result
  • Log info (crashfile, APlog, ANR, tombstone, coredump or STT, tracing logs, etc.)
  • Occurrence
  • Additional Information (HW Platform, test Case/test Campaign/test App, vmlinux, secvm.elf, mobilevisor.elf, regression, reproducible in function test, etc.)

Note: Double check to make sure that the information you provided is public info (not confidential), especially in the attached log files or screenshots. 

 

Report a Security Vulnerability

To report a security vulnerability, please contact our security incident response team by following the instructions posted at https://01.org/security.

 

Connect

    Join the #ProjectCeladon IRC channel for ad-hoc discussions and chats
irc://freenode.net/#ProjectCeladon
    Email the mailing list to ask questions, share knowledge or discuss issues: celadon@lists.01.org
Subscribe to the mailing list: https://lists.01.org/mailman/listinfo/celadon
    Stay connected. Follow us @ProjectCeladon 
    Stay connected. Follow us https://plus.google.com/u/1/109881732143027763646

For any other inquiries, email celadon-info@01.org