improve Contributors Guide

[aleeusgr]

As the project continues to grow and attract new contributors, it's essential that we provide a clear and comprehensive guide for those looking to contribute to the repository. The current contributing guide, while a good starting point, could be improved to better serve our community.

Details

Goals:

• Clarify the step-by-step process for submitting a pull request
• Add more detailed information on code review and feedback
• Include examples of successful contributions to help new contributors understand what to expect
• Update the guide to reflect the latest project structures and conventions
• Make the guide more accessible and easy to understand for users of varying skill levels

Proposed Changes:

• Reorganize the contributing guide to have a more logical flow of information
• Add screenshots or diagrams to illustrate complex concepts
• Use clear and concise language throughout the guide
• Provide a simple checklist for contributors to follow before submitting a pull request
• Link to relevant documentation and resources for further reading

Why is this necessary?

• A well-documented contributing guide will help reduce the barrier to entry for new contributors
• Improved clarity and concision will save time and effort for both contributors and maintainers
• The guide should accurately represent the project's values and community standards

Example of desired outcome:

Contributors should be able to easily navigate the guide and successfully submit a pull request without requiring extensive prior knowledge or experience.

Related issues:

• [Feature request for new contributor onboarding process](link to related issue)
• [Update project documentation to reflect changes in project structure](link to related issue)

Your thoughts:

How do you think we can improve the contributing guide? Are there any specific sections or areas you'd like to see updated?

Find the old guide here