Enhance README Documentation for React Developer Community Kenya Website #147
Conversation
|
@festus-sulumeti is attempting to deploy a commit to the React Developers Kenya Team on Vercel. A member of the Team first needs to authorize it. |
|
@festus-sulumeti, thanks for this contribution. as per the contribution guidelines, try make the pull request against the develop branch. |
|
|
||
| Contributions are always welcome! | ||
|
|
||
| See [`contributing.md`](https://github.com/reactdeveloperske/reactdevske-website/blob/main/CONTRIBUTING.md) for ways to get started. | ||
| ### How to Contribute |
There was a problem hiding this comment.
For the contribution guidelines section, emphasize on the detailed instructions that are available on the contribution guidelines. Some steps are missing from this summary which are very important and are addressed on the contribution guidelines,
| - **Node.js**: Backend runtime. | ||
| - **Tailwind CSS**: Styling. | ||
| - **GitHub Actions**: CI/CD. | ||
| - **Netlify/Vercel**: Deployment. |
There was a problem hiding this comment.
Deployments are done on Vercel
| ## Figma design file | ||
| ## Technologies Used | ||
|
|
||
| - **React.js**: Frontend framework. |
There was a problem hiding this comment.
Add React,js as the frontend javascript library
| ## Technologies Used | ||
|
|
||
| - **React.js**: Frontend framework. | ||
| - **Node.js**: Backend runtime. |
There was a problem hiding this comment.
Add Next.js as the Frontend React Framework.
|
|
||
| ### 2. How do I report a bug? | ||
|
|
||
| You can report bugs by creating an issue in the [GitHub Issues](https://github.com/reactdeveloperske/reactdevske-website/issues) section. |
There was a problem hiding this comment.
Also add that one has to go through the contribution guidelines (add a markdown link) for guidance
|
|
||
| ### 3. Can I suggest new features? | ||
|
|
||
| Absolutely! Feel free to open a feature request in the [GitHub Issues](https://github.com/reactdeveloperske/reactdevske-website/issues) section. |
There was a problem hiding this comment.
Also add that one has to go through the contribution guidelines (add a markdown link) for guidance
| React Developers Kenya Community | ||
| Email: [[email protected]](mailto:[email protected]) | ||
| Website: [reactdevske.org](https://www.reactdevske.org/) | ||
|
|
There was a problem hiding this comment.
Add our kommunity page: https://kommunity.com/reactjs-developer-community-kenya-reactdevske/events/past
Add our github sponsors page: https://github.com/sponsors/reactdeveloperske
Add our opencollective page: https://opencollective.com/reactdevske
There was a problem hiding this comment.
Hello @festus-sulumeti
Thank's for your contribution, check out the comments added.
This PR updates the
README.mdfile to provide a more detailed and structured documentation for the project. The goal is to improve onboarding for new contributors, provide clear project details, and make the repository more informative.Changes Introduced
Checklist
###Related
Closes: #146