Skip to content

Commit eba7532

Browse files
adithya321cpg
authored andcommitted
Add Contributing guidelines (#174)
* Add Contributing Guidelines * Add Code Style Convention in README
1 parent 469848f commit eba7532

File tree

2 files changed

+39
-0
lines changed

2 files changed

+39
-0
lines changed

CONTRIBUTING.md

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Contributing
2+
3+
## Code style and structure
4+
5+
* Set the Code Style Scheme to `Default` in Android Studio settings.
6+
* Run `Reformat Code` on changed files before committing.
7+
* Please check out the [Code Style for Contributors](https://source.android.com/source/code-style.html) section in AOSP and maintain as much consistency with them as possible.
8+
9+
## Getting Started
10+
11+
1. Submit an issue describing your proposed change.
12+
2. Fork the repository on GitHub.
13+
3. Clone the fork : `git clone https://github.com/your-username/android.git`
14+
15+
## Making Changes
16+
17+
* Create a branch : `git checkout -b branch-name`. Please avoid working directly on the
18+
`master` branch.
19+
* Make commits of logical units.
20+
* Make sure your commit messages are in the proper format.
21+
* Make sure you have added the necessary tests for your changes.
22+
* Run _all_ the tests to assure nothing else was accidentally broken.
23+
24+
## Submitting Changes
25+
26+
* Push your changes to the branch in your fork of the repository.
27+
* Submit a pull request to the repository.
28+
* The contributors look at Pull Requests and review them on a regular basis.
29+
30+
## Additional Resources
31+
32+
* [#amahi IRC channel](http://talk.amahi.org/)
33+
* [Forking Projects](https://guides.github.com/activities/forking/)
34+
* [Proper Git Commit Messages and an Elegant Git History](http://ablogaboutcode.com/2011/03/23/proper-git-commit-messages-and-an-elegant-git-history)

README.md

+5
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,11 @@ This is something to keep **private** and you obtain it by asking in the [Amahi
3333

3434
3. Once you have built the application, you will be needing credentials to use the application. Go to Amahi website and create your account, once the account is activated, you will see the description on how to setup Amahi server. However, this is not strictly needed, as we have a set up of a demo server called "Welcome to Amahi" which you should see even without your own server installed.
3535

36+
## Code Style Convention
37+
38+
* Set the Code Style Scheme to `Default` in Android Studio settings.
39+
* Run `Reformat Code` on changed files before committing.
40+
* Please check out the [Code Style for Contributors](https://source.android.com/source/code-style.html) section in AOSP and maintain as much consistency with them as possible.
3641

3742
## Generating the documentation
3843

0 commit comments

Comments
 (0)