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 Documentation #45

Open
towles-osu opened this issue Nov 30, 2022 · 2 comments
Open

Contributing Documentation #45

towles-osu opened this issue Nov 30, 2022 · 2 comments

Comments

@towles-osu
Copy link

I'd like to make the documentation around contributing a little more comprehensive. I am a first time Open Source contributor and I found it a little difficult to navigate how to contribute to this project. I also go confused going down the rabbit hole of the "Up For Grabs" description in the current Contirbuting.md.

I am initiating and claiming this issue.

I created a new version of the contributing documentation based on some articles I read about Open Source Documentation design. I hope these changes are helpful. I will make a PR in accordance with the outlined methods.

@towles-osu
Copy link
Author

I have resolved this issue and made a PR with the changes. Changes are in PR 46

@franciscop
Copy link
Owner

Sorry @towles-osu but that's a great general resource, but not for each specific project that you might want to contribute, hence I closed the issue. I agree with some small bits though, so feel free to reopen it rewording the Contributing.md guideliness, but not creating multiple documents.

React Test is basically stable at this point, there's a couple of minor things that could be improved and tested better but I don't think there's any major work that I think would be very useful at this stage. So the Contribution guidelines is effectively out of date with the "Up For Grabs" etc.

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

Successfully merging a pull request may close this issue.

2 participants