Skip to content

Commit

Permalink
Improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
KonradStaniec committed Aug 26, 2024
1 parent 2e1ca86 commit 7448be7
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 24 deletions.
28 changes: 5 additions & 23 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,8 @@ Depending on the scope of the work, we differentiate between self-contained pull

* Fork the repo (core developers must create a branch directly in the Babylon repo),
branch from the HEAD of `main`, make some commits, and submit a PR to `main`.
* Follow branch name conventions: `{prefix}/branch-name`, where `prefix` is one of the
standard [types](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json)
* For developers who are core contributors and are working within the Babylon repo, follow branch name conventions to ensure clear
ownership of branches: `{moniker}/branch-name`.
* See [Branching Model](#branching-model-and-release) for more details.

**Large contributions**:
Expand Down Expand Up @@ -91,29 +91,11 @@ This convention ensures that all changes that are committed to the base branch f

### Requesting Reviews

In order to accommodate the review process, the author of the PR must complete the author checklist
(from the pull request template)
to the best of their abilities before marking the PR as "Ready for Review". If you would like to
receive early feedback on the PR, open the PR as a "Draft" and leave a comment in the PR indicating
If you would like to receive early feedback on the PR, open the PR as a "Draft" and leave a comment in the PR indicating
that you would like early feedback and tagging whoever you would like to receive feedback from.

Codeowners are marked automatically as the reviewers.

All PRs require at least two review approvals before they can be merged (one review might be acceptable in
the case of minor changes to [docs](./.github/PULL_REQUEST_TEMPLATE/docs.md) or [other](./.github/PULL_REQUEST_TEMPLATE/other.md) changes that do not affect production code). Each PR template has a reviewers checklist that must be completed before the PR can be merged. Each reviewer is responsible
for all checked items unless they have indicated otherwise by leaving their handle next to specific
items. In addition, use the following review explanations:

* `LGTM` without an explicit approval means that the changes look good, but you haven't thoroughly reviewed the reviewer checklist items.
* `Approval` means that you have completed some or all of the reviewer checklist items. If you only reviewed selected items, you must add your handle next to the items that you have reviewed. In addition, follow these guidelines:
* You must also think through anything which ought to be included but is not
* You must think through whether any added code could be partially combined (DRYed) with existing code
* You must think through any potential security issues or incentive-compatibility flaws introduced by the changes
* Naming must be consistent with conventions and the rest of the codebase
* Code must live in a reasonable location, considering dependency structures (for example, not importing testing modules in production code, or including example code modules in production code).
* If you approve the PR, you are responsible for any issues mentioned here and any issues that should have been addressed after thoroughly reviewing the reviewer checklist items in the pull request template.
* If you sat down with the PR submitter and did a pairing review, add this information in the `Approval` or your PR comments.
* If you are only making "surface level" reviews, submit notes as a `comment` review.
the case of minor changes or changes that do not affect production code).

### Updating Documentation

Expand Down Expand Up @@ -144,7 +126,7 @@ To generate the protobuf stubs, you can run `make proto-gen`.

## Branching Model and Release

Repository should adhere to the trunk based development branching model: https://trunkbaseddevelopment.com.
User-facing repos should adhere to the trunk based development branching model: https://trunkbaseddevelopment.com. User branches should start with a user name, example: `{moniker}/branch-name`.

Babylon follows [semantic versioning](https://semver.org), but with the some deviations to account for state-machine and API breaking changes. See [RELEASE_PROCESS.md](./RELEASE_PROCESS.md) for details.

Expand Down
2 changes: 1 addition & 1 deletion RELEASE_PROCESS.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
- [Tagging Procedure](#tagging-procedure)
- [Patch release Procedure](#patch-release-procedure)

This document outlines the release process for Babylon node (Babylond)
This document outlines the release process for Babylon node (babylond)

Babylon follows [semantic versioning](https://semver.org), but with the following deviations to account for state-machine and API breaking changes.

Expand Down

0 comments on commit 7448be7

Please sign in to comment.