-
-
Notifications
You must be signed in to change notification settings - Fork 184
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.
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
Extract help and test info to new shared docs files #674
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
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,23 @@ | ||
# Help | ||
|
||
Make sure you have read the "Guides" section of the [C track][c-track] on the Exercism site. | ||
This covers the basic information on setting up the development environment expected by the exercises. | ||
|
||
## Submitting Incomplete Solutions | ||
|
||
If you are struggling with a particular exercise, it is possible to submit an incomplete solution so you can see how others have completed the exercise. | ||
|
||
## Resources | ||
|
||
To get help if having trouble, you can use the following resources: | ||
|
||
- [StackOverflow][] can be used to search for your problem and see if it has been answered already. You can also ask and answer questions. | ||
- [CPPReference][] can be used to look up information on C concepts, operators, types, standard library functions and more. | ||
- [TutorialsPoint][] has similar content as CPPReference in its C programming section. | ||
- [The C Programming][K&R] book by K&R is the original source of the language and is still useful today. | ||
|
||
[c-track]: https://exercism.io/my/tracks/c | ||
[stackoverflow]: http://stackoverflow.com/questions/tagged/c | ||
[cppreference]: https://en.cppreference.com/w/c | ||
[tutorialspoint]: https://www.tutorialspoint.com/cprogramming/ | ||
[K&R]: https://www.amazon.com/Programming-Language-2nd-Brian-Kernighan/dp/0131103628/ |
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,19 @@ | ||
# Tests | ||
|
||
Get the first test compiling, linking and passing by following the [three rules of test-driven development][3-tdd-rules]. | ||
|
||
The included makefile can be used to create and run the tests using the `test` task. | ||
|
||
```console | ||
make test | ||
``` | ||
|
||
Create just the functions you need to satisfy any compiler errors and get the test to fail. | ||
Then write just enough code to get the test to pass. | ||
Once you've done that, move onto the next test. | ||
|
||
As you progress through the tests, take the time to refactor your implementation for readability and expressiveness and then go on to the next test. | ||
|
||
Try to use standard C99 facilities in preference to writing your own low-level algorithms or facilities by hand. | ||
|
||
[3-tdd-rules]: http://butunclebob.com/ArticleS.UncleBob.TheThreeRulesOfTdd |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for unwrapping all of this 👍