You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
As a contributor to PrimeNG, I've noticed our growing reliance on community contributions, especially with the introduction of the "Help wanted" tag. I think this is a positive direction for the project, I believe we can make the contribution process more accessible and efficient by establishing detailed contributing guidelines, similar to what Next.js has implemented. https://github.com/vercel/next.js/blob/canary/contributing.md
I'd like to share my personal experience: When I first started contributing, one of the biggest challenges I faced was setting up a local development environment that could effectively test repro samples. Specifically, I spent hours linking/importing the master channel's PrimeNG code to a sample reproduction. This setup is crucial for:
Quickly verifying if reported issues are still present
Testing if proposed fixes actually resolve the problems
Getting immediate feedback on code modifications without rebuilding the entire showcase app
I ended up placing the sample into the apps folder, making part of the monorepo:
Is it the best solution? It works well for me.
Clear documentation about these processes would have saved me and others time and effort.
So I propose creating comprehensive guidlines that includes the following:
Development environment setup instructions
Step-by-step guide for creating local PrimeNG builds to test applications
Testing procedures and requirements
PR submission guidelines and best practices
Code style and convention requirements
Common troubleshooting solutions
And whatever you think might be useful.
By implementing these guidelines, we could reduce the learning curve for new contributors and increase the quality of submitted PRs speeding up the review process for you.
This documentation would particularly benefit:
First-time or one-time contributors who only want to solve a small issue and go on.
Developers trying to solve "Help wanted" issues
Anyone unfamiliar with the repository structure
Community members wanting to verify or fix reported bugs
reacted with thumbs up emoji reacted with thumbs down emoji reacted with laugh emoji reacted with hooray emoji reacted with confused emoji reacted with heart emoji reacted with rocket emoji reacted with eyes emoji
-
As a contributor to PrimeNG, I've noticed our growing reliance on community contributions, especially with the introduction of the "Help wanted" tag. I think this is a positive direction for the project, I believe we can make the contribution process more accessible and efficient by establishing detailed contributing guidelines, similar to what Next.js has implemented. https://github.com/vercel/next.js/blob/canary/contributing.md
I'd like to share my personal experience: When I first started contributing, one of the biggest challenges I faced was setting up a local development environment that could effectively test repro samples. Specifically, I spent hours linking/importing the master channel's PrimeNG code to a sample reproduction. This setup is crucial for:
I ended up placing the sample into the
apps
folder, making part of the monorepo:Is it the best solution? It works well for me.
Clear documentation about these processes would have saved me and others time and effort.
So I propose creating comprehensive guidlines that includes the following:
By implementing these guidelines, we could reduce the learning curve for new contributors and increase the quality of submitted PRs speeding up the review process for you.
This documentation would particularly benefit:
@mertsincan @cetincakiroglu @mehmetcetin01140
Beta Was this translation helpful? Give feedback.
All reactions