README.md 2.87 KB
Newer Older
freetrader's avatar
freetrader committed
1
2
# Bitcoin Cash Node announcements

3
4
5
6
7
This repository contains a list of official public announcements and
reports released by the project. This is considered to be the canonical
source for such official project announcements.

## Structure of contents
freetrader's avatar
freetrader committed
8
9
10

Please refer to the contained files which should be named in the format

freetrader's avatar
freetrader committed
11
    YYYY-mm-dd_<some English description with underscores instead of whitepace>_EN.md
12

freetrader's avatar
freetrader committed
13
14
15
16
17
18
19
20
21
or in the case of translated documents:

    YYYY-mm-dd_<English title>_<two letter language code>_<translated title>.md

There should be no whitespace in the filenames - use underscores instead.

The date prefix of each file indicates the **date of initial publication** of the
announcement or article. Translations should not update those dates, but use
the date of the original article.
22
23

Note: Older announcements were prefixed with `YYYYmmdd_` but we are moving
freetrader's avatar
freetrader committed
24
to the ISO-8601 date standard for new announcements (after 2021-11-24).
25

freetrader's avatar
freetrader committed
26
The two letter language codes used are based on ISO-639-1, as follows:
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
- EN: English
- ES: Spanish
- JA: Japanese
- KO: Korean
- ZH: Chinese

Each announcement or article is a date-prefixed file in the main folder,
but may reference content from subfolders such as bitmap images from `img/`.
Where a report includes other files, these files should be named in a way
that clearly associates them with the report, and where possible their most
easily editable source format should be provided for future maintenance and
translation purposes.

## Drafting content for this repository

Please use the `draft/` folder when drafting announcements for which the
publication date is still unknown.

The draft files can be named with placeholders for the date ranges that
need fixing, eg.

freetrader's avatar
freetrader committed
48
49
50
51
    2021-12-xx_technical_report_on_uptake_of_new_feature_XYZ_EN.md

In cases where a report is first written in a language other than English,
please append the language code after the title.
52

freetrader's avatar
freetrader committed
53
54
55
56
The relocation to the main folder and setting a suitable English title and
the correct date of publication (both in the content and in the file naming)
will be made as part of the merge request process after the content has been
approved.
freetrader's avatar
freetrader committed
57

58
59
## Want to sign an announcement to express your approval?

60
61
You can use the git hash of the commit of the version you approve, as part of your signing 'message'.
This strongly identifies the contents that you're signing.
62
63
64

You can alternatively download the raw text, and sign a digest of that.

btcfork's avatar
btcfork committed
65
66
67
68
69
70
71
Ways to sign(al) your support:

*  Bitcoin signing
*  PGP / GPG
*  keybase sign
*  [memo.cash](https://memo.cash) or [Member](https://memberapp.github.io/) posts

72
73
74
Once signed, you may want to publish the signature by adding it into this repository.
If that is the case, please use the `signatures/2021-12-xx_technical_report_on_uptake_of_new_feature_XYZ/` folder.

75
76
Please help us to improve by raising issues if you spot something wrong.

btcfork's avatar
btcfork committed
77
78
Thanks,

79
\- The Bitcoin Cash Node team