Skip to content

Commit ac7ef1a

Browse files
authored
Update README and CONTRIBUTING (#1905)
1 parent e0eb13f commit ac7ef1a

File tree

2 files changed

+10
-26
lines changed

2 files changed

+10
-26
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -14,24 +14,11 @@ If you send us a pull request, our CLA bot will ask you to sign the
1414
Contributor's License Agreement so that we can use your contribution.
1515

1616

17-
# Copyright
17+
# Copyright notice
1818

1919
Make sure that every file that contains significant work (at least every code file)
20-
starts with the copyright header:
21-
22-
```
23-
/*
24-
* Copyright © All Contributors. See LICENSE and AUTHORS in the root directory for details.
25-
*/
26-
```
27-
28-
You can set this in Android Studio:
29-
30-
1. Settings / Editor / Copyright / Copyright Profiles
31-
2. Paste the text above (without the stars).
32-
3. Set Formatting so that the preview exactly looks like above; one blank line after the block.
33-
4. Set this copyright profile as the default profile for the project.
34-
5. Apply copyright: right-click in file tree / Update copyright.
20+
starts with the copyright header. Android Studio should do so automatically because the
21+
configuration is stored in the repository (`.idea/copyright`).
3522

3623

3724
# Style guide
@@ -110,8 +97,3 @@ Test classes should be in the appropriate directory (see existing tests) and in
11097
tested class. Tests are usually be named like `methodToBeTested_Condition()`, see
11198
[Test apps on Android](https://developer.android.com/training/testing/).
11299

113-
114-
# Authors
115-
116-
If you make significant contributions, feel free to add yourself to the [AUTHORS file](AUTHORS).
117-

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,20 @@
11

2+
[![Follow @davx5app@fosstodon.org](https://img.shields.io/mastodon/follow/109598783742737223?domain=https%3A%2F%2Ffosstodon.org&style=flat-square)](https://fosstodon.org/@davx5app)
23
[![Website](https://img.shields.io/website?style=flat-square&up_color=%237cb342&url=https%3A%2F%2Fwww.davx5.com)](https://www.davx5.com/)
3-
[![F-Droid](https://img.shields.io/f-droid/v/at.bitfire.davdroid?style=flat-square)](https://f-droid.org/packages/at.bitfire.davdroid/)
44
[![License](https://img.shields.io/github/license/bitfireAT/davx5-ose?style=flat-square)](https://github.com/bitfireAT/davx5-ose/blob/main/LICENSE)
5-
[![Follow @davx5app@fosstodon.org](https://img.shields.io/mastodon/follow/109598783742737223?domain=https%3A%2F%2Ffosstodon.org&style=flat-square)](https://fosstodon.org/@davx5app)
6-
[![Development tests](https://github.com/bitfireAT/davx5-ose/actions/workflows/test-dev.yml/badge.svg)](https://github.com/bitfireAT/davx5-ose/actions/workflows/test-dev.yml)
5+
[![F-Droid](https://img.shields.io/f-droid/v/at.bitfire.davdroid?style=flat-square)](https://f-droid.org/packages/at.bitfire.davdroid/)
6+
![GitHub Downloads (all assets, all releases)](https://img.shields.io/github/downloads/bitfireAT/davx5-ose/total?label=GitHub%20downloads)
77

88
![DAVx⁵ logo](app/src/main/res/mipmap-xxxhdpi/ic_launcher.png)
99

1010

1111
DAVx⁵
1212
========
1313

14-
Please see the [DAVx⁵ Web site](https://www.davx5.com) for
15-
comprehensive information about DAVx⁵, including a list of services it has been tested with.
14+
> [!IMPORTANT]
15+
> Please see the [DAVx⁵ Web site](https://www.davx5.com) for
16+
> comprehensive information about DAVx⁵, including a list of services it has been tested with,
17+
> a manual and FAQ.
1618
1719
DAVx⁵ is licensed under the [GPLv3 License](LICENSE).
1820

0 commit comments

Comments
 (0)