Skip to content
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

Jump to bottom

docs: guidelines on large contributions and feature branches #868

Merged
merged 7 commits into from
Apr 25, 2023
Merged

docs: guidelines on large contributions and feature branches #868

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
291c6f6
adding section on large contributions
mpoke Apr 20, 2023
e7335ff
add overview and info on feature branches
mpoke Apr 21, 2023
90b3a41
add feature branch exception clause
mpoke Apr 21, 2023
a0def18
Merge branch 'main' into marius/large-contributions
mpoke Apr 21, 2023
1dc9b8e
core team -> stewarding team
mpoke Apr 21, 2023
9bb77b2
Merge branch 'marius/large-contributions' of github.com:cosmos/interc…
mpoke Apr 21, 2023
055213a
apply review suggestions
mpoke Apr 22, 2023
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
22 changes: 21 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
- [Development Procedure](#development-procedure)
- [Testing](#testing)
- [Pull Requests](#pull-requests)
- [Large / complex contributions](#large--complex-contributions)
- [Pull Request Templates](#pull-request-templates)
- [Requesting Reviews](#requesting-reviews)
- [Updating Documentation](#updating-documentation)
Expand Down Expand Up @@ -85,6 +86,11 @@ Appropriate tests should be written with a new feature, and all existing tests s

### Pull Requests

In order for us to accept your contributions, you need to follow the guidelines in this document.
The reason for this is that while we are welcoming contributions, we are ultimately responsible
for maintaining the code that gets merged and eventually released.
Therefore, we need as much context as possible on the nature of all of the changes being merged.

Before submitting a pull request:

* synchronize your branch with the latest main and resolve any arising conflicts, i.e.,
Expand All @@ -106,7 +112,21 @@ PRs must have a category prefix that is based on the type of changes being made
[Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification.
Additionally, **each PR should only address a single issue**.

NOTE: when merging, GitHub will squash commits and rebase on top of the main.
**Note:** When merging, GitHub will squash commits and rebase on top of the main.

#### Large / complex contributions

For large/complex changes, it is **absolutely** required
to have up-front discussion in issues/GitHub discussions.
In some cases, it would be preferable to even have
synchronous design sessions to socialize a collective understanding
of the nature of incoming changes prior to the work even starting.

It needs to be feasible for our team to review large/complex changes.
This means that changes either need to be submitted in multiple small PRs
mpoke marked this conversation as resolved.
Show resolved Hide resolved
(300-500 lines per PR max) that build on top of one another, or that large
PRs need to be structured such that they can be reviewed commit by commit
(300-500 lines per commit max), with each commit performing a single logical task.

### Pull Request Templates

Expand Down