Skip to content

docs: update fork repository links #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
220nightmore-spec wants to merge 1 commit into
base: bgl
Choose a base branch
from
Open

docs: update fork repository links #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions CONTRIBUTING.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,20 +9,20 @@ propose changes to this document in a pull request.

== Getting started

1. Fork https://github.com/keep-network/keep-core[`keep-network/keep-core`]
1. Fork https://github.com/BitgesellOfficial/keep-core-bgl[`BitgesellOfficial/keep-core-bgl`]
2. Clone your fork
3. Follow the
https://github.com/keep-network/keep-core/tree/main/docs/development[installation
https://github.com/BitgesellOfficial/keep-core-bgl/tree/bgl/docs/development[installation
& build steps] in the developer documentation.
4. Set up the <<Development Tooling>>.
5. Open a PR against the `main` branch and describe the change you
5. Open a PR against the `bgl` branch and describe the change you
are intending to undertake in the PR description.

Before marking the PR as ready for review, make sure:

* It passes the linter checks (`npm run lint`) (see <<Pre-commit>> to make this
automatic).
* It passes the https://github.com/keep-network/keep-core/actions[continuous
* It passes the https://github.com/BitgesellOfficial/keep-core-bgl/actions[continuous
integration tests].
* Your changes have sufficient test coverage (e.g regression tests have
been added for bug fixes, unit tests for new features)
Expand All @@ -35,7 +35,7 @@ be signed].

=== Continuous Integration

Keep uses https://github.com/keep-network/keep-core/actions[Github Actions] for
Keep uses https://github.com/BitgesellOfficial/keep-core-bgl/actions[Github Actions] for
continuous integration. All jobs must be green to merge a PR.

=== Pre-commit
Expand Down
16 changes: 10 additions & 6 deletions README.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
= keep-core
= keep-core-bgl

https://github.com/keep-network/keep-core/actions/workflows/contracts-ecdsa.yml[image:https://img.shields.io/github/actions/workflow/status/keep-network/keep-core/contracts-ecdsa.yml?branch=main&event=push&label=ECDSA%20contracts%20build[ECDSA contracts build status]]
https://github.com/keep-network/keep-core/actions/workflows/contracts-random-beacon.yml[image:https://img.shields.io/github/actions/workflow/status/keep-network/keep-core/contracts-random-beacon.yml?branch=main&event=push&label=Random%20Beacon%20contracts%20build[Random Beacon contracts build status]]
https://github.com/keep-network/keep-core/actions/workflows/client.yml[image:https://img.shields.io/github/actions/workflow/status/keep-network/keep-core/client.yml?branch=main&event=push&label=Client build[Go client build status]]
https://github.com/BitgesellOfficial/keep-core-bgl/actions/workflows/contracts-ecdsa.yml[image:https://img.shields.io/github/actions/workflow/status/BitgesellOfficial/keep-core-bgl/contracts-ecdsa.yml?branch=bgl&event=push&label=ECDSA%20contracts%20build[ECDSA contracts build status]]
https://github.com/BitgesellOfficial/keep-core-bgl/actions/workflows/contracts-random-beacon.yml[image:https://img.shields.io/github/actions/workflow/status/BitgesellOfficial/keep-core-bgl/contracts-random-beacon.yml?branch=bgl&event=push&label=Random%20Beacon%20contracts%20build[Random Beacon contracts build status]]
https://github.com/BitgesellOfficial/keep-core-bgl/actions/workflows/client.yml[image:https://img.shields.io/github/actions/workflow/status/BitgesellOfficial/keep-core-bgl/client.yml?branch=bgl&event=push&label=Client build[Go client build status]]
https://docs.threshold.network[image:https://img.shields.io/badge/docs-website-green.svg[Docs]]
https://discord.gg/threshold[image:https://img.shields.io/badge/chat-Discord-5865f2.svg[Chat with us on Discord]]

This repository is the Bitgesell `bgl` branch of the Keep Core codebase. The
README keeps the upstream Keep documentation context below while repository
links and status badges point at this fork.

The core contracts and reference client implementation behind the Keep network,
a privacy, interoperability, and censorship-resistance toolkit for developers on
Ethereum.
Expand Down Expand Up @@ -41,7 +45,7 @@ A good place to start is link:docs/[the docs directory].
To run your own node in the Keep Network, follow the
link:https://docs.keep.network/run-keep-node.html[Run Keep Node] doc. Feedback
on this process and the documentation
https://github.com/keep-network/keep-core/issues[is appreciated!]
https://github.com/BitgesellOfficial/keep-core-bgl/issues[is appreciated!]

=== Moving to a new random beacon

Expand Down Expand Up @@ -76,7 +80,7 @@ The directory structure used in this repository is very similar to that used in
other Go projects:

```
keep-core/
keep-core-bgl/
Dockerfile
main.go, *.go
docs/
Expand Down