Skip to content

Commit f2427fd

Browse files
committed
Fixed formatting in the steps to prepare a PR.
1 parent 56c1711 commit f2427fd

File tree

1 file changed

+31
-36
lines changed

1 file changed

+31
-36
lines changed

CONTRIBUTING.rst

+31-36
Original file line numberDiff line numberDiff line change
@@ -73,42 +73,37 @@ When you've determined the branch to which you'd like to send a PR to
7373
you can follow these steps to prepare your change for inclusion in the
7474
library.
7575

76-
# Create an integration branch. This integration branch should be
77-
rooted off the branch you intend to send a PR to. For example, if
78-
you're sending a PR to cpp-netlib/master and your fork is
79-
user/master, you should create a user/master-integration branch.
80-
81-
# Create a topic branch. From the integration branch, you can then
82-
create as many topic branches as you want. It's recommended that you
83-
isolate all experimentation to branches — once you're resonably sure
84-
that your work is good to go, merge your topic branch into the
85-
integration branch in your local repo, then push the changes to your
86-
GitHub repo.
87-
88-
# Make sure your integration branch is up to date. To do this you
89-
should first pull changes to your local master (assuming that's where
90-
you'd like to send a pull request to), rebase your integration branch
91-
to the tip of master, then make sure all merge conflicts are dealt
92-
with. Proceed only when your integration branch is up-to-date with the
93-
official branch you're going to send your PR to.
94-
95-
# Send the PR. Once you're reasonably happy with the state of your
96-
integration branch, send off a PR to the official repo and set the
97-
destination branch as the branch you intend to send the change to.
98-
99-
# Address Comments The maintainers will be reviewing your changes, and
100-
sometimes they may have comments they will ask you to address in
101-
your PR. You can do this by going back to the second step of this
102-
process, but you don't need to send another PR -- all you have to do
103-
is push your changes to your GitHub hosted integration branch and
104-
your PR will be updated automatically. That said, don't forget to
105-
update the discussion on the PR that you're ready for the PR to be
106-
reviewed again.
107-
108-
# Your PR is merged. If you've done everything correctly up to this
109-
point, your PR should be cleanly merge-able into the branch you sent
110-
the PR to. A maintiner will merge you change into the project and
111-
you're now officially a contributor to the project!
76+
1. Create an integration branch. This integration branch should be
77+
rooted off the branch you intend to send a PR to. For example, if
78+
you're sending a PR to cpp-netlib/master and your fork is
79+
user/master, you should create a user/master-integration branch.
80+
2. Create a topic branch. From the integration branch, you can then
81+
create as many topic branches as you want. It's recommended that you
82+
isolate all experimentation to branches — once you're resonably sure
83+
that your work is good to go, merge your topic branch into the
84+
integration branch in your local repo, then push the changes to your
85+
GitHub repo.
86+
3. Make sure your integration branch is up to date. To do this you
87+
should first pull changes to your local master (assuming that's where
88+
you'd like to send a pull request to), rebase your integration branch
89+
to the tip of master, then make sure all merge conflicts are dealt
90+
with. Proceed only when your integration branch is up-to-date with the
91+
official branch you're going to send your PR to.
92+
4. Send the PR. Once you're reasonably happy with the state of your
93+
integration branch, send off a PR to the official repo and set the
94+
destination branch as the branch you intend to send the change to.
95+
5. Address Comments The maintainers will be reviewing your changes, and
96+
sometimes they may have comments they will ask you to address in
97+
your PR. You can do this by going back to the second step of this
98+
process, but you don't need to send another PR -- all you have to do
99+
is push your changes to your GitHub hosted integration branch and
100+
your PR will be updated automatically. That said, don't forget to
101+
update the discussion on the PR that you're ready for the PR to be
102+
reviewed again.
103+
6. Your PR is merged. If you've done everything correctly up to this
104+
point, your PR should be cleanly merge-able into the branch you sent
105+
the PR to. A maintiner will merge you change into the project and
106+
you're now officially a contributor to the project!
112107

113108

114109
In case you have multiple PR's in flight, you may want to have

0 commit comments

Comments
 (0)