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

[Docs/Github] CONTRIBUTING.md addition #4132

Open
riqts opened this issue Jan 28, 2024 · 4 comments
Open

[Docs/Github] CONTRIBUTING.md addition #4132

riqts opened this issue Jan 28, 2024 · 4 comments
Labels

Comments

@riqts
Copy link
Contributor

riqts commented Jan 28, 2024

The contributing guidelines on redux-toolkit could be made more inviting to first time users who are intimidated by OSS and contributing.

Options explored

Port over reduxjs/redux guidelines

the core repo's guidelines have a bit more flavor and could be ported over very easily to fit RTK.

unify core docs guidelines on the portal

Alternative/additionally, the "contributing" guidelines could just be made as a page on the core documentations website and the guidelines link to their similar to react's guidelines (although theirs links to the legacy site lol). This would just mean that across the three repos one guideline has to be maintained. (The page would still link to the 3 seperates repos and potentially clarify)


If PR's are welcome against this let me know, I suppose the first option is easy but if the second option is interesting I'll probs have to x-post to the actual repo receiving the change.

@EskiMojo14
Copy link
Collaborator

sure, any improvements to the CONTRIBUTING.md would be welcome :)

i don't know where we'd put it in the website, tbh

@itz-Me-Pj
Copy link
Contributor

itz-Me-Pj commented Jan 30, 2024

@EskiMojo14 created a PR for a more beginner friendly contribution doc addressing all the changes mentioned here. Pls review and suggest if you want any changes.
Also website seems to be a nice idea but it won't make sense as taking the contributor to a website on how to contribute and they have to come back to repository to perform the steps required for a successful contribution that is one additional step they have to perform. Instead, I would suggest that contribution guide should contain all the required things for a successful contribution.

@riqts
Copy link
Contributor Author

riqts commented Jan 31, 2024

it won't make sense as taking the contributor to a website on how to contribute and they have to come back to repository to perform the steps required for a successful contribution

FWIW I don't think them having to open a new tab would deter them too much from contributing if the new tab has a more indepth guide to them getting started.

But in saying that I am in no way married to the website idea, it was just a suggestion to try and centralise the contributing guidelines for the three repos and docs so they don't get desynced as easily.

A good example is django's contributing guidelines.

i don't know where we'd put it in the website, tbh

It could potentially just sit in its own file under Introduction or Tutorials (or even it's own dropdown for contributing on the sidebar) on redux.js.org/. I am happy to do this on the core docs too if its desired, but refreshing these docs is a good middle ground too and I did see a PR has been opened.

@itz-Me-Pj
Copy link
Contributor

@riqts It was just my opinion and it's not that I am totally against the website idea, in fact centralizing all the contribution guidelines in detail for all the repos sounds great. I had a look at django's website as well looks similar to nextjs's contribution.md.
But in short if the plan is to create a centralized doc for all the repos website is a great option otherwise for each repo contribution markdown would be enough.

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

No branches or pull requests

4 participants