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

CONTRIBUTING.md does not mention format of top comment #365

Closed
JHaig343 opened this issue Oct 3, 2019 · 2 comments
Closed

CONTRIBUTING.md does not mention format of top comment #365

JHaig343 opened this issue Oct 3, 2019 · 2 comments

Comments

@JHaig343
Copy link
Contributor

JHaig343 commented Oct 3, 2019

the part in particular:

# Tests
A test file is required with language additions. The file should
contain every variant comments and quotes, as well as a comment
at the top of the file containing the manually verified lines,
code, comments, blanks e.g.
`// 39 lines 32 code 2 comments 5 blanks`. The comment should use
the syntax of the language you're testing. A good example of a
test file is [`tests/data/rust.rs`].

Currently for tests to successfully run, the top comment needs to have a specific format:
X lines X code X comments X blanks
Which to md file does not mention. I propose adding to the md file to specifically mention the required format of the top comment.

@JHaig343
Copy link
Contributor Author

JHaig343 commented Oct 3, 2019

#63

@XAMPPRocky
Copy link
Owner

Thank you for your issue! I've updated the contributing information.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants