Skip to content

Commit 1fe8b0a

Browse files
committed
chore: metafiles update
1 parent 76c8ca1 commit 1fe8b0a

File tree

4 files changed

+67
-12
lines changed

4 files changed

+67
-12
lines changed

CHANGELOG.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Changelog
2+
3+
## [v1.1.1] - 2025-unreleased
4+
5+
### Added
6+
7+
- CHANGELOG.md
8+
9+
### Changed
10+
11+
- Bumped Go version to 1.25.1

CONTRIBUTING.md

Lines changed: 28 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@ All contributions are welcome.
55

66
## Issues
77

8-
_Sensitive security-related issues should be reported to any of [codeowners](/CODEOWNERS)._
8+
_Sensitive security-related issues should not be reported publicly.
9+
See [Security](SECURITY.md)._
910

1011
To share ideas, considerations, or concerned open an issue.
1112
Before filing an issue make sure the issue has not been already raised.
@@ -19,7 +20,7 @@ In the issue, answer the following questions:
1920

2021
Before opening a pull request open an issue on why the request is needed.
2122

22-
To contribute: fork the repo, make your improvements, commit and open a pull request.
23+
To contribute: fork the repo, make your improvements, commit, and open a pull request.
2324
The maintainers will review the request.
2425

2526
The request must:
@@ -39,11 +40,19 @@ Make sure you are using a version of go higher or equal to the one specified in
3940

4041
Get all the dependencies:
4142

43+
```bash
44+
go mod download
45+
```
46+
47+
of with
48+
4249
```bash
4350
go mod tidy
4451
```
4552

46-
Run all tests:
53+
### Tests
54+
55+
Run unit tests with
4756

4857
```bash
4958
go test ./...
@@ -55,8 +64,24 @@ Generate a coverage report:
5564
$ ./gencover.sh
5665
```
5766

67+
### Linting
68+
5869
Run linters (make sure you have [golangci-lint](https://golangci-lint.run/) installed) with
5970

6071
```bash
6172
golangci-lint run
6273
```
74+
75+
The linting configs are specified in [.golangci.yml](.golangci.yml).
76+
77+
## AI Assistance
78+
79+
Any significant use of the AI assistance in the contribution MUST be disclosed in the pull request along with the extent of the use.
80+
81+
An example disclosure:
82+
83+
> This PR was written primarily by Claude Code.
84+
85+
Or a more detailed disclosure:
86+
87+
> I consulted ChatGPT for the following code snippets: ...

README.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,14 @@
1-
<p align="left">
2-
<a href="https://flare.network/" target="blank"><img src="https://content.flare.network/Flare-2.svg" width="400" height="300" alt="Flare Logo" /></a>
3-
</p>
1+
<div align="center">
2+
<a href="https://flare.network/" target="blank">
3+
<img src="https://content.flare.network/Flare-2.svg" width="300" alt="Flare Logo" />
4+
</a>
5+
<br />
6+
<a href="CONTRIBUTING.md">Contributing</a>
7+
·
8+
<a href="SECURITY.md">Security</a>
9+
·
10+
<a href="CHANGELOG.md">Changelog</a>
11+
</div>
412

513
# Flare Data Connector Client
614

@@ -15,6 +23,8 @@ It does the following tasks:
1523

1624
The client has no direct interactions with the Flare blockchain/node. The data is read through C-Chain indexer and submitted through Flare System Client.
1725

26+
[![API Reference](https://pkg.go.dev/badge/github.com/flare-foundation/fdc-client)](https://pkg.go.dev/github.com/flare-foundation/fdc-client?tab=doc)
27+
1828
## Protocol
1929

2030
See [whitepaper](https://dev.flare.network/pdf/whitepapers/20240224-FlareDataConnector.pdf).

SECURITY.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,23 @@
22

33
We recommend using the latest released version.
44

5-
## Audit reports
6-
7-
Audit reports are published on Flare's [Developer Hub](https://dev.flare.network/support/audits/).
8-
95
## Reporting Vulnerabilities
106

117
Please do not report a vulnerability using an issue or any other public channel.
128

13-
To disclose a vulnerability reach out to any of the [codeowners](CODEOWNERS).
9+
If you have found a possible vulnerability, please send an email to `security at flare dot network`.
10+
11+
## Bug bounties
12+
13+
We sincerely appreciate and encourage reports of suspected security vulnerabilities.
14+
Please refer to our [Immunefi Bug Bounty Program](https://immunefi.com/bug-bounty/flarenetwork/information/) for scope, rules, and submission guidelines.
1415

15-
See TODO for the active bug bounties.
16+
## Vulnerability disclosures
17+
18+
Critical vulnerabilities will be disclosed via GitHub's
19+
[security advisory](https://github.com/flare-foundation/verifier-indexer-framework/security)
20+
system.
21+
22+
## Audit reports
23+
24+
Audit reports are published on Flare's [Developer Hub](https://dev.flare.network/support/audits/).

0 commit comments

Comments
 (0)