Skip to content

Commit

Permalink
DOCS update: 14 day rule & gitter badge
Browse files Browse the repository at this point in the history
  • Loading branch information
renekliment committed Mar 1, 2017
1 parent b424bc1 commit 2eb0b74
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 4 deletions.
10 changes: 9 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,15 @@ Please stick to this to keep the code clean, readable and consistent.
## For core developers
Let's stick to the rule that no one (not even core developers) pushes directly to the repo. Every time one wants to make a change - even a silly one, it has to go through the Pull Request mechanism and at least one other core developer (one with push access to the repo) has to do a code review and agree with it before pulling it into `master`.
Let's stick to the rule that no one (not even core developers) pushes directly to the repo. Every time one wants to make a change - even a silly one, it has to go through the Pull Request mechanism and at least one other core developer (one with push access to the repo) has to do a code review and agree with it before pulling it into `dev` or `master`.
### 14-day PR review window rule
When there is an open PR with no blocking objections for at least 14 days, it can be merged without explicit approval of other team members.
It's perfectly understandable that people don't have time to devote to AlexaPi to review stuff and if people with write access merge something even without a proper review, it will bring more good than harm to the project (keeps the development running, makes the project better as only people who have proved themselves have write access).
An attempt to contact relevant team members has to be made (team mention for example). This rule is to account for people being busy, unavailable or unwilling rather than trying to sneak PRs through.
## If you want to check out someone else's branch (for example a Pull Request)
Expand Down
4 changes: 1 addition & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
# AlexaPi (the new & awesome version)
# AlexaPi (the new & awesome version) [![Gitter chat](https://badges.gitter.im/alexa-pi/Lobby.png)](https://gitter.im/alexa-pi/Lobby)

This is a client for Amazon's Alexa service. It is intended and tested to run on a wide range of platforms, such as Raspberry Pi, Orange Pi, CHIP and ordinary Linux desktops.

**NOTE: This is a new generation of the project under ~~heavy~~ some development. There can be a few glitches, but it's definitely ready to use if you're an advanced user.**

### Do you want to help out? Read the [Contribution Guide](CONTRIBUTING.md).

### Check out the [Documentation Wiki](https://github.com/alexa-pi/AlexaPi/wiki) and [Change Log](CHANGELOG.md).
Expand Down

0 comments on commit 2eb0b74

Please sign in to comment.