Skip to content

Commit

Permalink
Added CONTRIBUTING guidelines (#36)
Browse files Browse the repository at this point in the history
* Added CONTRIBUTING guidelines
* keep Project.xml code style
  • Loading branch information
MarcoSignoretto authored Jun 29, 2021
1 parent 59d7269 commit 1711eb6
Show file tree
Hide file tree
Showing 3 changed files with 165 additions and 1 deletion.
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,6 @@ crashlytics-build.properties
fabric.properties

# Styles
.idea/codeStyles/Project.xml
workspace.xml

# VS Code files
Expand Down
130 changes: 130 additions & 0 deletions .idea/codeStyles/Project.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

35 changes: 35 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Contributing to MockingBird

Careem welcomes contributions of all kinds and sizes. This includes everything from simple bug reports to large features.

Workflow
--------

We love GitHub issues!

For small feature requests, an issue first proposing it for discussion or demo implementation in a PR suffice.

For big features, please open an issue so that we can agree on the direction, and hopefully avoid investing a lot of time on a feature that might need reworking.

Small pull requests for things like typos, bug fixes, etc are always welcome.

### Code style

* Use 4 spaces to indent your code
* Do not use star imports

DOs and DON'Ts
--------------

* DO follow kotlin standard coding conventions [coding style](https://kotlinlang.org/docs/coding-conventions.html)
* DO include tests when adding new features. When fixing bugs, start with adding a test that highlights how the current behavior is broken.
* DO keep the discussions focused. When a new or related topic comes up it's often better to create new issue than to side track the discussion.

* DON'T submit PRs that alter licensing related files or headers. If you believe there's a problem with them, file an issue and we'll be happy to discuss it.

Guiding Principles
------------------

* We allow anyone to participate in our projects. Tasks can be carried out by anyone that demonstrates the capability to complete them
* Always be respectful of one another. Assume the best in others and act with empathy at all times
* Collaborate closely with individuals maintaining the project or experienced users. Getting ideas out in the open and seeing a proposal before it's a pull request helps reduce redundancy and ensures we're all connected to the decision making process

0 comments on commit 1711eb6

Please sign in to comment.