Skip to content

Commit 471c89b

Browse files
committed
Updating contributing guidelines
(Internal change: 2264975)
1 parent d6f3294 commit 471c89b

2 files changed

Lines changed: 30 additions & 23 deletions

File tree

docs/contributing_supplemental.rst

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
11
===================
2-
Contributing to USD
3-
===================
4-
52
Supplemental Terms
6-
******************
3+
===================
74

85
By and in consideration for using a Pixar site (e.g., Pixar's USD-proposals
96
site), providing Submissions to Pixar, or by clicking a box that states that

docs/contributing_to_usd.rst

Lines changed: 29 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -42,34 +42,27 @@ Pull Request Guidelines
4242
to the "**dev**" branch when filing your pull request.
4343

4444
* Please make sure all tests are passing with your change prior to
45-
submitting a pull request.
46-
47-
* We highly recommend posting issues on GitHub for features or bug fixes
48-
that you intend to work on before beginning any development. That way, if
49-
someone else is working on a similar project, you can collaborate, or you
50-
can get early feedback which can sometimes save time.
45+
submitting a pull request. Keep in mind the current github CI pipeline
46+
does not run any tests, however tests will be run when reviewing your
47+
submitted change for consideration.
5148

5249
* Please make sure that your pull requests are clean. Use the rebase and
5350
squash git facilities as needed to ensure that the pull request is as
5451
clean as possible.
5552

56-
* Please make pull requests that are small and atomic - in general, it is
57-
easier for us to merge pull requests that are small and serve a single
58-
purpose than those that are sweeping and combine several functional pieces
59-
in a single PR.
53+
* Please make pull requests that are small and atomic. In general, it is
54+
easier for us to merge pull requests that serve a single
55+
purpose than those that combine several functional pieces.
56+
57+
* Please search through existing open github issues and associate your PR
58+
with issues that your change addresses, as described in :ref:`github_issues`.
59+
If there are no issues related to your change, you do not need to create
60+
a new issue.
6061

6162
Git Workflow
6263
************
6364

64-
Here is the workflow we recommend for working on USD if you intend on
65-
contributing changes back:
66-
67-
#. Post an issue on github to let folks know about the feature or bug that
68-
you found, and mention that you intend to work on it. That way, if
69-
someone else is working on a similar project, you can collaborate, or you
70-
can get early feedback which can sometimes save time.
71-
72-
.. | space |
65+
Here is the workflow we recommend for contributing changes to USD:
7366

7467
#. Use the github website to fork your own private repository.
7568

@@ -137,3 +130,20 @@ contributing changes back:
137130
#. Now your remote branch will have your dev_mybugfix branch, which you can
138131
now pull request (to USD's dev branch) using the github UI.
139132

133+
.. _github_issues:
134+
135+
Github Issues
136+
#############
137+
138+
Use github issues to report problems or suggestions that need discussion, or
139+
that you might not be able to address yourself.
140+
141+
You do not need to log an issue for contributing changes, or if your change
142+
fixes an unreported issue. However, if your change requires multiple pull
143+
requests, a single issue can be created and referenced from those PRs to
144+
organize them.
145+
146+
Before sending your change in for consideration, search through the list of
147+
`open issues on github <https://github.com/PixarAnimationStudios/USD/issues>`_
148+
and check if your change addresses any issue. If so, associate your pull
149+
request with that issue.

0 commit comments

Comments
 (0)