-
Notifications
You must be signed in to change notification settings - Fork 231
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 guidelines #416
Comments
@M-Pixel thanks for the issue, out of curiosity can you please provide what errors you encountered when trying to install dependencies and/or run the unit tests? |
Build Errors
Appears to be caused by an old version of So perhaps not something that instructions would have prevented, then. I can post a different issue for this if you'd like. Before spending too much time investigating, I assumed there may have been setup steps that I missed, as that's usually been the cause of build failure for a fresh project in my experience. TestsTest errors came from the doctest. I figured out how to fix them, but a brief overview of the development setup would have meant less debugging, more proactive development. |
So the error from We are currently moving away from
The only thing i saw coming from the doctest were warnings of unhandled promise rejections which is simply because the docs are missing This does not reflect any issues with the actual code just an oversight on our part about the examples in the README.md and API.md which should be addressed I definitely agree that we should have a Contributing Guidelines... so thank you very much for opening the issue. If you have any ideas or thoughts on how they should look please let us know. Thank again! |
Yeah, it's unfortunate that this is a contextify problem, and that Buster depends on contextify. Alas, it is basically out of our control. It's one reason, like @davidchase said, we've already switched to mocha in @most/core. So, while it's annoying and noisy, everything should still work just fine. I think we could put together a simple CONTRIBUTING doc quickly, perhaps something like when's or cycle's. |
those look very nice and simple 👍 |
I was thinking in addition to "dos and don'ts", a brief summary of what all the components are, or a list of steps usually taken from start to finish in the course of making a contribution. I see that there are three different test commands run, but I don't know why there are three or what the distinction is. For example, if a test fails after making some change, I don't know if it's because I broke something or because I missed a step and needed to update some secondary test. Style is largely communicated by the lint configuration and code itself, so I don't think guidelines would need to include that. |
Please provide documentation (step by step walkthrough from scratch to PR) indicating how to contribute to this project.
Simply cloning, I was unable to install dependencies or run unit tests without errors.
The text was updated successfully, but these errors were encountered: