Various improvements to CONTRIBUTING.md
AetherUnbound opened this issue · 12 comments
Description
While looking at our CONTRIBUTING.md file, I noticed a number of improvements that could be made:
- We should link to the CONTRIBUTING.md file in our main repo, as it has a lot of depth to it:
https://github.com/WordPress/openverse/blob/0b5e24bd325da7b75db9484a268d7c8d197ae920/CONTRIBUTING.md - We should remove the reference to
CODEBASE.md, which no longer exists: https://github.com/WordPress/openverse-api/blob/main/CONTRIBUTING.md?plain=1#L11 - We should add a reference to
DOCUMENTATION_GUIDELINES.md: https://github.com/WordPress/openverse-api/blob/429fd45916c9e064ccea772afc184466304bce4e/DOCUMENTATION_GUIDELINES.md - We should remove the line about GitHub discussions (they are currently disabled) in both places its referenced:
https://github.com/WordPress/openverse-api/blob/main/CONTRIBUTING.md?plain=1#L21
https://github.com/WordPress/openverse-api/blob/main/CONTRIBUTING.md?plain=1#L97
Additional context
Inspired by https://github.com/WordPress/openverse-catalog/issues/775
Resolution
- 🙋 I would be interested in resolving this bug.
Hello @AetherUnbound I'm interested in contributing to this issue! Please tell me how to get started.
Hi @Yash-Pratapwar! We'd love to have you help out with this 😄 If you're looking for how to contribute in general, you can take a look at the contributing guide in our main repo! That should have all the instructions for getting started.
For this particular issue, all of the changes we'd like made to the contributing file in this repo are described in the issue description.
I'll assign the issue to you for now 🙂 If you have any more specific questions about contribution, feel free to ask here or in our Make WP Slack!
Thanks @AetherUnbound I have gone through the contributing guide, I had a doubt, whether WSL is required for resolving this issue?
If you're using Windows for your primary development machine, then it's likely that you will need to use WSL in order to run the linting and testing steps. If you're making changes to documentation only, then you may not need to set WSL up to make the changes 🙂 If you're not on Windows (most of the maintainers use OSX or Linux) then you're already set!
I think we should also replace any commands listed with just recipes where available, e.g. just api-test and just ing-testlocal.
Yes, noted.
@AetherUnbound after removing the line 21 what should I add there instead? I have added a reference to DOCUMENTATION_GUIDELINES.md in that same section, is it ok or should I refrence it in some other section?
I think you could recommend asking a question in the Make WP Slack, similar to what is in the catalog's contributing doc: WordPress/openverse-catalog@3217ed5#diff-eca12c0a30e25b4b46522ebf89465a03ba72a03f540796c979137931d8f92055R23
Description
While looking at our
CONTRIBUTING.mdfile, I noticed a number of improvements that could be made:
- We should link to the CONTRIBUTING.md file in our main repo, as it has a lot of depth to it:
https://github.com/WordPress/openverse/blob/0b5e24bd325da7b75db9484a268d7c8d197ae920/CONTRIBUTING.md- We should remove the reference to
CODEBASE.md, which no longer exists: https://github.com/WordPress/openverse-api/blob/main/CONTRIBUTING.md?plain=1#L11- We should add a reference to
DOCUMENTATION_GUIDELINES.md: https://github.com/WordPress/openverse-api/blob/429fd45916c9e064ccea772afc184466304bce4e/DOCUMENTATION_GUIDELINES.md- We should remove the line about GitHub discussions (they are currently disabled) in both places its referenced:
https://github.com/WordPress/openverse-api/blob/main/CONTRIBUTING.md?plain=1#L21
https://github.com/WordPress/openverse-api/blob/main/CONTRIBUTING.md?plain=1#L97Additional context
Inspired by WordPress/openverse#1413
Resolution
- 🙋 I would be interested in resolving this bug.
@AetherUnbound In the first point you said 'main repo' did you mean this repo (Openverse)?
That's correct!
@AetherUnbound Ok, so for that I would need to fork the Openverse repo then, I did the other 3 tasks for which I will create a PR.