Commit f88af24f authored by Robert Hitt's avatar Robert Hitt
Browse files

Made CONTRIBUTING.md a bit more Android-ey

parent 04f0a19a
Pipeline #941 passed with stages
in 9 minutes and 12 seconds
...@@ -107,24 +107,23 @@ Before you submit your Merge Request (MR) consider the following steps: ...@@ -107,24 +107,23 @@ Before you submit your Merge Request (MR) consider the following steps:
For example if I compose the following function: For example if I compose the following function:
```python ```java
# file.py int oneplus(int num) {
def oneplus(num): return num + 1;
return num + 1 }
``` ```
then I would additionally write the following test case: then I would additionally write the following test case:
```python ```java
# test_file.py @Test
def TestOneplus(TestCase): void TestOneplus() {
assertEquals(oneplus(1), 2) assertEquals(2, oneplus(1));
}
``` ```
* Before you push your code to GitLab it is suggested that you run all unit tests locally. * Before you push your code to GitLab it is suggested that you run all unit tests locally.
* [Guide for running local unit tests in Android Studio](https://developer.android.com/training/testing/unit-testing/local-unit-tests.html#run)
```sh
python manage.py test
```
* Commit your changes using a descriptive commit message that follows our * Commit your changes using a descriptive commit message that follows our
[commit message conventions](#commit). Adherence to these conventions is strongly [commit message conventions](#commit). Adherence to these conventions is strongly
...@@ -203,7 +202,7 @@ To ensure consistency throughout the source code, keep these rules in mind as yo ...@@ -203,7 +202,7 @@ To ensure consistency throughout the source code, keep these rules in mind as yo
are working: are working:
* All features or bug fixes **must be tested** by one or more specs (unit-tests). * All features or bug fixes **must be tested** by one or more specs (unit-tests).
* We follow [the PEP8 styleguide][style-guide]. * This project doesn't have a strict style guide, but [this](https://source.android.com/source/code-style.html) is generally good to follow.
## <a name="commit"></a> Commit Message Guidelines ## <a name="commit"></a> Commit Message Guidelines
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment