-
Notifications
You must be signed in to change notification settings - Fork 929
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
Updating code of conduct #2288
Comments
@zhaoyunxing92 @AlexStocks @chickenlj What do you think about this? |
This PR updates contributing and issue template to make easier collaboration. Fixes: apache#2288 Signed-off-by: Xuewei Niu <justxuewei@apache.org>
This PR updates contributing and issue template to make easier collaboration. Fixes: #2288 Signed-off-by: Xuewei Niu <justxuewei@apache.org>
I think it's a good practice to provide templates as a guide for contributors. It's always good to see an issue or pull request that is clearly stated its purpose, the scope of changes, etc. But I think we should also notice that it could be more practical for us to apply an agile policy at present to allow quick iteration, especially for the development branch, so it should not be seen a mandatory request. |
There are more and more people coming to the community and contributing code. We need to have a strict code of conduct to maintain efficient collaboration.
Contributing
The format of the title of PRs should be:
The types are including(https://www.freecodecamp.org/news/how-to-write-better-git-commit-messages/):
If this PR is to backport to other branchs, e.g.
3.0
, then the title would be:Each pull request MUST have a corresponding issue to explain what does this PR do. The format of message should be:
The signed-off message will be appended automaticaly if the developers commit with
-s
option, for example,git commit -s
.Besides, the workflows (GitHub actions) will be updated to check if PRs follow the rules.
Issue Template
If bug reporters do not give enough information about their environment, it is too hard to debug and find which part is not working properly. Therefore, we need to update our issue template to guide users to provide more information. It should be:
Environment
Issue description
(Here is a brief description about the issue.) Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
Logs
Click me to check logs
The text was updated successfully, but these errors were encountered: