Docs: Contribution Guide #462
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
webecke
added
documentation
1 task
19mdavenport
reviewed
Nov 6, 2024
ThanGerlek
requested changes
Nov 7, 2024
webecke
force-pushed
the
contributing-guidlines
branch
2 times, most recently
from
6df4051 to
5282693
Compare
|
This PR has been updated to merge into the #452 (which it was based on) so that the PR diff views appear properly. |
ThanGerlek
reviewed
Nov 14, 2024
…contributing-guidlines Proposed "When to Create an Issue" section
ThanGerlek
approved these changes
Nov 16, 2024
|
I can't figure out whats going on with the diff on this PR. it should only have a few markdown files different from |
19mdavenport
force-pushed
the
contributing-guidlines
branch
from
d8c0b24 to
e3f5499
Compare
- Provide details on PR dependencies - Call out the bulleted list
In generaly, now new content was added, but links and images to existing resources were added. In some cases, clarifying words were added to emphasize particular points. In few cases, the linting of the file was improved. Most of the linting issues in this file were not touched.
This fixes and standardizes the whitespace, and indention in the file. Not all of the automatic suggestions were taken at face value. Plenty of them were manually reverted or manually adjusted to better match human expectations.
frozenfrank
approved these changes
Nov 30, 2024
| - `remove unused imports` | ||
| - `refactor test runner` | ||
| - `document API endpoints` | ||
| - Use lowercase letters |
There was a problem hiding this comment.
But I like writing my commits in sentence case with the first letter capitalized. Is that an issue?
This allows an IDE to open up just that nested root folder, and still have access to the getting started guide.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
This PR introduces a Contribution Guide that makes official a lot of assumed practices on the Autograder development team, and helps new developers know how to contribute.
Please give your feedback! I don't want this to be just the Dallin said so document. What needs changing? What's redundant or too much? What's missing?
Details
CONTRIBUTING.mdFuture Work
Two things come to mind as I've been working on this, which should be separate issues
Also, this branch was based on the
README-improvementsbranch, not main, so a rebase might be required if this PR is finished before the other one