search

RPG-Alex / rust-micro-cms

An attempt to tie together serverside logic, database logic, and client view all with Rust under the hood.
MIT License
3 stars 1 forks source link

Contributing needs to be its own file. #35

Open RPG-Alex opened 6 months ago

RPG-Alex commented 6 months ago

Project needs to follow contribution standards and make it easy for new developers to sign on and help, and also declutter the readme.md

ryukaizen commented 6 months ago

Hey @RPG-Alex, I want to contribute!

RPG-Alex commented 6 months ago

Hey @ryukaizen, it’s fantastic to see your enthusiasm for contributing to the Rust Micro CMS project!

To help streamline our project's documentation and make it more accessible for new contributors like yourself, I recommend we create a separate CONTRIBUTING.md file. This document should clearly outline the steps and best practices for contributions. Here are a few suggestions on what to include:

  1. Introduction: Briefly explain the purpose of the project and how contributors can add value: -Small footprint: One of the guiding principles for the project is for a cms it should have a smaller footprint -Rust First: from front to back this is meant to be a rust built framework (in fact I am considering redoing the db to switch to a rust one) -.env for all config: The project needs to take advantage of a .env file for config related settings, such as for db file location, url for frontend (for cors) etc.
  2. Code of Conduct: I would like to include a link to the Code of Conduct to ensure all contributors maintain a respectful and inclusive environment, and base it off of the Rust code of conduct.
  3. Setting Up the Development Environment: Provide detailed instructions on setting up the development environment, similar to what we currently have but expanded to include potential troubleshooting steps and common issues. And then obviously migrate that info from the readme to the new contributions file, and cleanup the readme.
  4. How to Contribute:
    • Forking and Cloning: Guide on how to fork the repository and clone it to their local machine. Currently for most projects I prefer that new contributors reach out first, and anything pushed to this repo needs to be on a new branch regardless for testing.
    • Making Changes: Advice on making changes in a thoughtful manner, including coding standards and the preferred coding style.
    • Commit Messages: Guidance on how to write meaningful commit messages that clearly explain the changes might be helpful, but I think this could be a minimal addition too.
  5. Submitting Pull Requests: Steps on how to create a pull request after making changes, including how to title and describe the pull request to improve readability and review efficiency.
  6. How to Report Bugs/Issues: Instructions on how to report issues or bugs effectively, including the details that should be included (like system configuration, reproductions steps, and expected vs. actual results).

It would also be helpful to include links to resources for learning more about Rust and contributing to open-source projects in general. This could make the contribution process more engaging and educational for newcomers.

I've assigned this issue to you, are you comfortable taking the lead on this CONTRIBUTING.md file and readme revisions?

BTW my goal is to implement this philosophy/guide for making the project newcomer friendly.

RPG-Alex commented 6 months ago

Update: Added a branch for this issue as well.

ryukaizen commented 6 months ago

are you comfortable taking the lead on this CONTRIBUTING.md file and readme revisions?

Yes, I'll try my best!

I should start working with my fork copy first, will update you on this, thanks for the guidance.

RPG-Alex commented 5 months ago

@ryukaizen Checking in, any progress on this issue?

ryukaizen commented 5 months ago

Hello @RPG-Alex, apologies for the delay, I have been busy with academics. I've nearly completed the documentation part, it needs good formatting. I'll update you on this soon, thanks for checking in.