Skip to content

docs: update CONTRIBUTING fork links #2

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 CONTRIBUTING fork links #2

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
8 changes: 4 additions & 4 deletions CONTRIBUTING.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,18 @@ Feel free to propose changes to this document in a pull request.

== Getting started

1. Fork https://github.com/keep-network/tbtc-v2[`keep-network/tbtc-v2`]
1. Fork https://github.com/BitgesellOfficial/tbgl-v2[`BitgesellOfficial/tbgl-v2`]
2. Clone your fork
3. Each module has their own setup instructions. Follow the README of the
specific module you want to contribute to.
4. Set up the <<Development Tooling>>.
5. Open a PR against the `main` branch and describe the change you are intending
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 (see <<Pre-commit>> to make this automatic).
* It passes the https://github.com/keep-network/tbtc-v2/actions[continuous
* It passes the https://github.com/BitgesellOfficial/tbgl-v2/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 @@ -32,7 +32,7 @@ be signed].

=== Continuous Integration

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

=== Pre-commit
Expand Down