forked from exercism/rust
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
begin v3 era contributing documentation (exercism#1177)
* start revising contributing documentation * clarify wording * Update README.md Co-authored-by: Peter Goodspeed-Niklaus <[email protected]> * add counter example, stylistic comparison * caveat Exercism-wide contributing * Update docs/CONTRIBUTING.md Co-authored-by: Peter Goodspeed-Niklaus <[email protected]> * condense line * condense line * caveat and more rewording * Apply suggestions from code review Co-authored-by: Peter Goodspeed-Niklaus <[email protected]> * add other improvements * lint contributing.md Co-authored-by: Peter Goodspeed-Niklaus <[email protected]>
- Loading branch information
1 parent
8ce806d
commit 75f5b8b
Showing
3 changed files
with
42 additions
and
10 deletions.
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,3 @@ | ||
#!/usr/bin/env bash | ||
set -e | ||
npx markdownlint-cli concepts/**/*.md exercises/**/*.md docs/maintaining.md | ||
npx markdownlint-cli concepts/**/*.md exercises/**/*.md docs/maintaining.md docs/CONTRIBUTING.md |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
# Contributing to the Rust Exercism Track | ||
|
||
This track is a work in progress. | ||
Please take all the value you can from it, but if you notice any way to improve it, we are eager for pull requests. | ||
Fixing a typo in documentation is every bit as valid a contribution as a massive addition of code. | ||
|
||
> A work of art is never finished, merely abandoned. | ||
> | ||
> -- Paul Valéry | ||
Nonetheless, feel free to peruse what we have written thus far! | ||
|
||
*Contributions welcome :)* | ||
|
||
As one of the many tracks in Exercism, contributions here should observe Exercism standards like the [Code of Conduct](https://exercism.io/code-of-conduct). | ||
This document introduces the ways you can help and what maintainers expect of contributors. | ||
|
||
## Ways to Contribute | ||
|
||
As with many Open Source projects, work abounds. | ||
Here are a few categories of welcome contribution: | ||
- improving existing exercises | ||
- creating new exercises | ||
- improving internal tooling | ||
- updating documentation | ||
- fixing typos, misspellings, and grammatical errors | ||
|
||
|
||
## Merging Philosophy | ||
|
||
A [pull request](https://docs.github.com/en/github/getting-started-with-github/github-glossary#pull-request) should address one logical change. | ||
This could be small or big. | ||
|
||
For example, [#1175](https://github.com/exercism/rust/pull/1175) fixed a single typo in a single file after minutes of collaboration. | ||
|
||
It was a small, short pull request with one logical change. | ||
|
||
[#653](https://github.com/exercism/rust/pull/653) introduced the doubly linked list exercise after months of collaboration. | ||
|
||
It was a big, long-running pull request with one logical change. |