-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Added CONTRIBUTING guidelines * keep Project.xml code style
- Loading branch information
1 parent
59d7269
commit 1711eb6
Showing
3 changed files
with
165 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |