Skip to content
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

Test Directory Documentation #5538

Closed
Trott opened this issue Mar 2, 2016 · 5 comments
Closed

Test Directory Documentation #5538

Trott opened this issue Mar 2, 2016 · 5 comments
Labels
doc Issues and PRs related to the documentations. test Issues and PRs related to the tests.

Comments

@Trott
Copy link
Member

Trott commented Mar 2, 2016

The test directory has a number of subdirectories that could use some explanation. It is probably a good idea to add a README to that directory to explain what each subdirectory is and whether or not the tests in that directory get run on the continuous integration server or not. (Look at the test-ci task in the Makefile to find out.)

I'm labeling this good first contribution even though a first-time contributor might not know what all the directories are. Don't worry about it, First Time Contributor! Just take your best guess after perusing the test files in each directory for a little bit and any mistakes will get sorted out in the pull request conversation.

@Trott Trott added test Issues and PRs related to the tests. good first issue Issues that are suitable for first-time contributors. labels Mar 2, 2016
@mscdex mscdex added the doc Issues and PRs related to the documentations. label Mar 2, 2016
@mike182uk
Copy link
Contributor

Howdy, i've had a stab at this here, if you have any feedback that would be great! You can preview the rendered markdown here.

@MylesBorins
Copy link
Contributor

This may be a good a time as any to talk about our debugger directory doing nothing

@Trott
Copy link
Member Author

Trott commented Mar 4, 2016

Removing the good first contribution label since we have a viable PR for it now. (Thanks, @mike182uk!)

@Trott Trott removed the good first issue Issues that are suitable for first-time contributors. label Mar 4, 2016
@Trott
Copy link
Member Author

Trott commented Mar 4, 2016

@thealphanerd Working on it, one test file at a time. #5532

@Trott
Copy link
Member Author

Trott commented May 11, 2016

This was fixed (at least an initial doc) by @mike182uk so I'm going to close this issue.

@Trott Trott closed this as completed May 11, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations. test Issues and PRs related to the tests.
Projects
None yet
Development

No branches or pull requests

4 participants