Missing contribution guidelines

[ad-m-ss]

Hi there,

Firstly, thank you for sharing your work with the community. I believe that your project has the potential to be a valuable resource for many developers.

However, I noticed that there are currently no contributing guidelines available for this project. As someone who is interested in contributing to open-source projects, I find this lack of guidance a bit concerning.

Without contributing guidelines, it's unclear to me whether your project is open-source and open-contribution, or whether it is open-source but not open-contribution, like SQLite. I do not if am the only person who is unsure about this, and it might be discouraging for potential contributors who are unclear about how they can contribute to your project.

Therefore, I kindly ask that you consider adding contributing guidelines to your repository. I believe that this will benefit both you and potential contributors. Here are some suggestions on what information should be included in such guidelines:

• Purpose and Goals: Clearly state the purpose of your project and implementation goals and why contributions are welcomed. Do we prefer upstream projects to self-publish the schema in the appropriate format upstream, or do we want to collect all schemas here, also when upstream it's already properly published?
• Review Process: Explain how contributions are reviewed and what the process looks like.
• Coding Standards: Provide clear coding standards to ensure consistency and readability of the codebase.
• Testing Guidelines: Explain how to run the project tests and provide instructions for writing new tests.
• Contact Information: Provide contact information for the project maintainers or community members who can help with questions and issues.

By adding these guidelines, you can make it easier for potential contributors to understand how they can contribute to your project, and ensure that contributions are made in a consistent and constructive manner.

I know that I am asking for a lot, but these are only suggestions for issues that can be raised. They can be noted at the beginning in a minimum, and develop as more doubts begin to appear.

Thank you for your time and consideration, and I look forward to hearing your thoughts on this matter.

Best regards,
Adam Dobrawy

[ad-m-ss]

Oh, I just notice a paragraph here: https://github.com/datreeio/CRDs-catalog#contributing-crds-to-the-catalog
However, it's still not clear to me:

• relationship with upstream projects
• testing - I see some configuration in CI, but probably developers have some way to run it locally too

[eyarz]

@ad-m-ss thank you for the feedback!
Just to clarify, this is an open-source project that accepts PRs from the community.

We already have an open issue regarding this (#52), so if you're interested, feel free to open a PR with a draft for the contribution guide, and we can work on it together :)

[eyarz]

@ad-m-ss can I close this issue?