[COMPASS-7358] [Developer experience] CONTRIBUTING.md does not mention prerequisites; "Getting started" steps are incomplete and cannot be executed Created: 18/Oct/23 Updated: 01/Nov/23 Resolved: 01/Nov/23 |
|
| Status: | Closed |
| Project: | Compass |
| Component/s: | None |
| Affects Version/s: | None |
| Fix Version/s: | No version |
| Type: | Bug | Priority: | Minor - P4 |
| Reporter: | Inga L | Assignee: | Unassigned |
| Resolution: | Won't Do | Votes: | 0 |
| Labels: | None | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Environment: |
OS: Alpine Edge (with nodejs and npm packages from v3.16) x86_64. |
||
| Documentation Changes: | Not Needed |
| Description |
Problem Statement/RationaleWhat is going wrong? What action would you like the Engineering team to take? Steps to ReproduceHow could an engineer replicate the issue you’re reporting? Expected ResultsWhat do you expect to happen? Actual ResultsWhat do you observe is happening? Additional NotesAny additional information that may be useful to include. Some specific examples:
None of these issues are very significant, but they block outside contributors from following CONTRIBUTING.md, and might also make developer experience worse for new internal contributors (unless this is already resolved in some internal onboarding document). Unfortunately, because the list of issues above is non-exhaustive (because I wasn't able to get even `npm install` to finish successfully), I cannot submit any patch to CONTRIBUTING.md. |
| Comments |
| Comment by Inga L [ 01/Nov/23 ] |
|
Just an update: I was able to run npm run bootstrap on Ubuntu 22.04 LTS with Node v16 and npm v8, but I still had to install g++ and make (but nothing else). I was even able to run some tests. So updating CONTRIBUTING.md with the list of supported systems (Alpine is definitely not supported, Ubuntu 22.04 LTS seems to be supported... what else is?) and mentioning that standard node-gyp dependencies are required should be enough to resolve this ticket (and to simplify onboarding for new contributors) |
| Comment by Inga L [ 01/Nov/23 ] |
|
Hi julia.oppenheim@mongodb.com, thank you for the feedback. I've just researched things a bit deeper and it seems that Alpine support is a problem in general for MongoDB, both for the server and the tools (e.g. I'll try to set up an Ubuntu container later and see if I encounter any problems with it. My guess is that I'll still have to install `make`, `gcc`, `krb5-dev` etc, so it might still be worth it to update CONTRIBUTING.md with the list of prerequisites (and mention that only some systems, such as Ubuntu, are supported for contributors). |
| Comment by Julia Oppenheim [ 01/Nov/23 ] |
|
Hi inga.lovinde@outlook.com - we're closing this ticket for now, as this is a pretty specific edge case. We will revisit the priority of this in the future if it continues to come up. Thank you for your attention to this! |
| Comment by Inga L [ 18/Oct/23 ] |
|
There is a mistype in the issue description, but I don't see how to edit it: > So while e.g. node v18 and npm v10 satisfy these requirements, npm v8.10 (from Alpine v3.16 repository) does *NOT* satisfy them. |
| Comment by PM Bot [ 18/Oct/23 ] |
|
Hello inga.lovinde@outlook.com, thank you for reaching out to us! The team will review your issue and get back to you soon as soon as possible. Please review your issue to ensure you've included your environment details and have attached relevant logs (with any sensitive data redacted), so that we're best able to provide you a timely and thorough response. Thanks again! |