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

一个JAVA项目该有的样子 #7

Open
MregXN opened this issue Dec 5, 2022 · 0 comments
Open

一个JAVA项目该有的样子 #7

MregXN opened this issue Dec 5, 2022 · 0 comments

Comments

@MregXN
Copy link
Owner

MregXN commented Dec 5, 2022

  1. 实现功能,编译通过可运行;
  2. 添加Unit Test,粒度尽量小
  3. 清晰易懂的变量名,函数名
  4. 配置formatter文件
  5. 添加注释
  6. 在每个文件开头及根目录内添加LICENSE
  7. 添加README,以萌新用户的视角写说明书
  8. 添加checkstyle代码风格检查
  9. 添加.gitignore防止提交不需要的文件
  10. 切换特定分支,commit时描述言简意赅,push
  11. 配置Github Workflow完成测试,构建,发布的自动化
@MregXN MregXN changed the title 一个repo该有的样子 一个JAVA项目该有的样子 Dec 6, 2022
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