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

[discussion] Improve the documentation and processes for contributing code. #418

Open
psxjoy opened this issue Aug 22, 2024 · 1 comment

Comments

@psxjoy
Copy link
Contributor

psxjoy commented Aug 22, 2024

Hi everyone. After dealing with some small tasks, I realized there are some areas where the project’s code contribution guidelines could be improved. Specifically:

  1. Establishing a consistent code style (and providing a code style file).
  2. Providing a brief yet accurate introduction for each component.
  3. Including configuration details necessary to run the source code.
  4. Other relevant details.

I’ve wasted some time during development due to the first-three issues. I think adding these elements could make the project more appealing to other developers and encourage open-source contributions.

@psxjoy
Copy link
Contributor Author

psxjoy commented Aug 22, 2024

If possible, I’m more than willing to take on this responsibility. I’ll also continuously collaborate with the relevant project leaders to create the most effective documentation for the project’s open-source contribution guidelines.
Feel free to assign it to me anytime.@wtt40122 @gaoxh @wodiwudi

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant