Skip to content

Commit

Permalink
Initial Outline
Browse files Browse the repository at this point in the history
  • Loading branch information
terafin committed Mar 3, 2020
1 parent 77932bb commit c9bbb25
Show file tree
Hide file tree
Showing 26 changed files with 674 additions and 0 deletions.
10 changes: 10 additions & 0 deletions .clang-format
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
Language: Cpp
BasedOnStyle: WebKit
---
Language: C
BasedOnStyle: WebKit
---
Language: ObjC
BasedOnStyle: WebKit
...
13 changes: 13 additions & 0 deletions .github/workflows/build-main.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
name: World Build

on: [push]

jobs:
build:

runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v2
# - name: Run Build
# run: make
23 changes: 23 additions & 0 deletions .github/workflows/clang-tidy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: Tidy

on: [pull_request]

jobs:
build:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v2
- name: Get changed files
id: get-changed-files
uses: futuratrepadeira/changed-files@v3.0.0
with:
repo-token: ${{ github.token }}
- name: clang-tidy
uses: ./actions/clang-tidy
id: clang-tidy
env:
GITHUB_TOKEN: ${{ github.token }}
CLANG_ARGUMENTS: "-checks=-*,clang-analyzer-*,-clang-analyzer-cplusplus* -- -Isrc/includes"
FILES_MODIFIED: ${{ steps.get-changed-files.outputs.files_updated }}
FILES_ADDED: ${{ steps.get-changed-files.outputs.files_created }}
35 changes: 35 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Prerequisites
*.d

# Compiled Object files
*.slo
*.lo
*.o
*.obj

# Precompiled Headers
*.gch
*.pch

# Compiled Dynamic libraries
*.so
*.dylib
*.dll

# Fortran module files
*.mod
*.smod

# Compiled Static libraries
*.lai
*.la
*.a
*.lib

# Executables
*.exe
*.out
*.app

# VS Code Configs
*.vscode
24 changes: 24 additions & 0 deletions .restyled.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
image: restyled/restyler-clang-format:v9.0.0
command:
- clang-format
- "-i"
arguments: []
include:
- "**/*.c"
- "**/*.cc"
- "**/*.cpp"
- "**/*.cxx"
- "**/*.c++"
- "**/*.C"
- "**/*.cs"
- "**/*.h"
- "**/*.hh"
- "**/*.hpp"
- "**/*.hxx"
- "**/*.h++"
- "**/*.H"
- "**/*.java"
- "**/*.js"
- "**/*.m"
interpreters: []
1 change: 1 addition & 0 deletions BUILDING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
## Build Documentation
77 changes: 77 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@

# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to make participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, sex characteristics, gender identity and expression,
level of experience, education, socio-economic status, nationality, personal
appearance, race, religion, or sexual identity and orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment
include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.

## Scope

This Code of Conduct applies within all project spaces, and it also applies when
an individual is representing the project or its community in public spaces.
Examples of representing a project or community include using an official
project e-mail address, posting via an official social media account, or acting
as an appointed representative at an online or offline event. Representation of
a project may be further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at [INSERT EMAIL ADDRESS]. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq
192 changes: 192 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,192 @@
Contributing to CHIP
========================

Want to contribute? Great! First, read this page (including the small
print at the end).
By submitting a pull request, you represent that you have the right to license your contribution to Zigbee and the
community, and agree by submitting the patch that your contributions are licensed under the
[Apache 2.0 license](./LICENSE.md).

Before submitting the pull request, please make sure you have tested your changes and that they follow the project
[guidelines for contributing code](./docs/contribution_guidelines.md).


## Bugs

If you find a bug in the source code, you can help us by [submitting a GitHub Issue](https://github.com/project-chip/connectedhomeip/issues/new). The best bug reports provide a detailed description of the issue and step-by-step instructions for predictably reproducing the issue. Even better, you can [submit a Pull Request](#submitting-a-pull-request) with a fix.

## New Features

You can request a new feature by [submitting a GitHub Issue](https://github.com/project-chip/connectedhomeip/issues/new).

If you would like to implement a new feature, please consider the scope of the new feature:

* *Large feature*: first [submit a GitHub
Issue](https://github.com/project-chip/connectedhomeip/issues/new) and communicate
your proposal so that the community can review and provide feedback. Getting
early feedback will help ensure your implementation work is accepted by the
community. This will also allow us to better coordinate our efforts and
minimize duplicated effort.

* *Small feature*: can be implemented and directly [submitted as a Pull
Request](#submitting-a-pull-request).

## Contributing Code

CHIP follows the "Fork-and-Pull" model for accepting contributions.

### Initial Setup

Setup your GitHub fork and continuous-integration services:

1. Fork the [CHIP
repository](https://github.com/project-chip/connectedhomeip) by clicking "Fork"
on the web UI.

2. All contributions must pass all checks and reviews to be accepted.

Setup your local development environment:

```bash
# Clone your fork
git clone git@github.com:<username>/connectedhomeip.git

# Configure upstream alias
git remote add upstream git@github.com:project-chip/connectedhomeip.git
```

### Submitting a Pull Request

#### Branch

For each new feature, create a working branch:

```bash
# Create a working branch for your new feature
git branch --track <branch-name> origin/master

# Checkout the branch
git checkout <branch-name>
```

#### Create Commits

```bash
# Add each modified file you'd like to include in the commit
git add <file1> <file2>

# Create a commit
git commit
```

This will open up a text editor where you can craft your commit message.

#### Upstream Sync and Clean Up

Prior to submitting your pull request, you might want to do a few things to
clean up your branch and make it as simple as possible for the original
repository's maintainer to test, accept, and merge your work.

If any commits have been made to the upstream master branch, you should rebase
your development branch so that merging it will be a simple fast-forward that
won't require any conflict resolution work.

```bash
# Fetch upstream master and merge with your repository's master branch
git checkout master
git pull upstream master

# If there were any new commits, rebase your development branch
git checkout <branch-name>
git rebase master
```

Now, it may be desirable to squash some of your smaller commits down into a
small number of larger more cohesive commits. You can do this with an
interactive rebase:

```bash
# Rebase all commits on your development branch
git checkout
git rebase -i master
```

This will open up a text editor where you can specify which commits to squash.


#### Push and Test

```bash
# Checkout your branch
git checkout <branch-name>

# Push to your GitHub fork:
git push origin <branch-name>
```

This will trigger the continuous-integration checks. You
can view the results in the respective services. Note that the integration
checks will report failures on occasion.

#### Pull Request Requirements

CHIP considers there to be a few different types of pull requests:
- Trivial bug fix
- - Decription 1
- - Decription 2
- Small Bug fix
- - Decription 1
- - Decription 2
- Bug Fix
- - Decription 1
- - Decription 2
- Significiant Change
- - Decription 1
- - Decription 2
- Feature
- - Decription 1
- - Decription 2
- Architecture Change
- - Decription 1
- - Decription 2

### Prior to review, all changes require:
- [GitHub Workflows](../.github/workflows) pass
- [Certification Tests](tests/certification/README.md) pass
- [Unit Tests](tests/unit/README.md) pass
- [Fuzz Tests](tests/fuzz/README.md) pass
- [Integration Tests](tests/integration/README.md) pass
- Linting passes
- Code style passes

Each type of change has unique additional requirements, here's a table of those:
| Type | Reviewer Requirements | New Unit Tests | New Certification Tests | New Fuzz Tests | New Integration Tests |
|----|----|----|----|----|----|
| Trivial bug fix | | | | | |
| Small Bug fix | | | | | | |
| Bug Fix | | | | | | |
| Significiant Change | | | | | | |
| Feature | | | | | | |
| Architecture Change | | | | | | |



#### Submit Pull Request

Once you've validated the CI results, go to the page for
your fork on GitHub, select your development branch, and click the pull request
button. If you need to make any adjustments to your pull request, just push the
updates to GitHub. Your pull request will automatically track the changes on
your development branch and update.

#### Code reviews

All submissions, including submissions by project members, require review.

### Documentation

Documentation undergoes the same review process as code

See the [Documentation Style Guide][doc-style] for more information on
how to author and format documentation for contribution.

3 changes: 3 additions & 0 deletions CONTRIBUTORS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
The following organizations and individuals have contributed to the CHIP SDK:
* Apple Inc
* Google Inc
Loading

0 comments on commit c9bbb25

Please sign in to comment.