Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Missing contribution guidelines for alpha stage APIs #1267

Open
artur-ciocanu opened this issue Mar 18, 2025 · 3 comments
Open

Missing contribution guidelines for alpha stage APIs #1267

artur-ciocanu opened this issue Mar 18, 2025 · 3 comments
Labels
kind/bug Something isn't working

Comments

@artur-ciocanu
Copy link
Contributor

Expected Behavior

The CONTRIBUTING.md file should contain enough details about how should we contribute implementations for alpha stage APIs like:

  • where should we add the APIs to which interface
  • how should we prefix the alpha API methods, like Alpha1
  • which version should we use like 1.x.x vs 0.x.x for alpha stage modules

Actual Behavior

Currently there are no instructions in the CONTRIBUTING.md file.

Steps to Reproduce the Problem

Please check the current CONTRIBUTING.md file.

Release Note

RELEASE NOTE:

@artur-ciocanu artur-ciocanu added the kind/bug Something isn't working label Mar 18, 2025
@artur-ciocanu
Copy link
Contributor Author

@cicoyle and @salaboy could you please let me know your thoughts.

@siri-varma
Copy link

I think this is a great idea. But do you think we could further offload it to contributors by adding some automation, like Checkstyle? For example, alpha APIs usually have 'alpha' in their method names. We could create a rule to check if a method name from the Dapr import contains 'alpha' and ensure the calling method also has 'alpha' in its name.

I understand it is easier said than done. But wanted to know everyone thoughts as well.

@cicoyle
Copy link
Contributor

cicoyle commented Mar 19, 2025

Our Contributing.md file mostly aligns with dapr/dapr's. I would be happy to see it expanded on.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/bug Something isn't working
Projects
None yet
Development

No branches or pull requests

3 participants