You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by GitBox <gi...@apache.org> on 2022/03/08 09:52:59 UTC

[GitHub] [apisix-ingress-controller] jwrookie opened a new pull request #907: docs: add pre-commit todo in the development guide

jwrookie opened a new pull request #907:
URL: https://github.com/apache/apisix-ingress-controller/pull/907


   <!-- Please answer these questions before submitting a pull request -->
   
   ### Type of change:
   
   <!-- Please delete options that are not relevant. -->
   
   - [ ] Bugfix
   - [ ] New feature provided
   - [ ] Improve performance
   - [ ] Backport patches
   
   ### What this PR does / why we need it:
   <!--- Why is this change required? What problem does it solve? -->
   <!--- If it fixes an open issue, please link to the issue here. -->
   Resolves #906
   
   ### Pre-submission checklist:
   
   <!--
   Please follow the requirements:
   1. Use Draft if the PR is not ready to be reviewed
   2. Test is required for the feat/fix PR, unless you have a good reason
   3. Doc is required for the feat PR
   4. Use a new commit to resolve review instead of `push -f`
   5. Use "request review" to notify the reviewer once you have resolved the review
   -->
   
   * [ ] Did you explain what problem does this PR solve? Or what new features have been added?
   * [ ] Have you added corresponding test cases?
   * [ ] Have you modified the corresponding document?
   * [ ] Is this PR backward compatible? **If it is not backward compatible, please discuss on the [mailing list](https://github.com/apache/apisix-ingress-controller#community) first**
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [apisix-ingress-controller] lingsamuel merged pull request #907: docs: add pre-commit todo in the development guide

Posted by GitBox <gi...@apache.org>.
lingsamuel merged pull request #907:
URL: https://github.com/apache/apisix-ingress-controller/pull/907


   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [apisix-ingress-controller] tao12345666333 commented on a change in pull request #907: docs: add pre-commit todo in the development guide

Posted by GitBox <gi...@apache.org>.
tao12345666333 commented on a change in pull request #907:
URL: https://github.com/apache/apisix-ingress-controller/pull/907#discussion_r821578009



##########
File path: docs/en/latest/development.md
##########
@@ -103,3 +103,18 @@ Something you need to pay attention to:
 
 * configuring of `--kubeconfig`, if you are using Minikube, the file path should be `~/.kube/config`.
 * configuring of `--default-apisix-cluster-admin-key`, if you have changed the admin key in Apache APISIX, also changing it here. If you have disabled the authentication in Apache APISIX, just removing this option.
+
+## Pre-commit todo
+
+When everything is ready, before submitting the code, please make sure that the license, code style, and document format are consistent with the project specification.
+
+We provide commands to implement it, just run the following commands:
+```shell
+make update-license
+make update-mdlint
+make update-gofmt

Review comment:
       We also need to add `make update-codegen`




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [apisix-ingress-controller] jwrookie commented on a change in pull request #907: docs: add pre-commit todo in the development guide

Posted by GitBox <gi...@apache.org>.
jwrookie commented on a change in pull request #907:
URL: https://github.com/apache/apisix-ingress-controller/pull/907#discussion_r821598224



##########
File path: docs/en/latest/development.md
##########
@@ -103,3 +103,18 @@ Something you need to pay attention to:
 
 * configuring of `--kubeconfig`, if you are using Minikube, the file path should be `~/.kube/config`.
 * configuring of `--default-apisix-cluster-admin-key`, if you have changed the admin key in Apache APISIX, also changing it here. If you have disabled the authentication in Apache APISIX, just removing this option.
+
+## Pre-commit todo
+
+When everything is ready, before submitting the code, please make sure that the license, code style, and document format are consistent with the project specification.
+
+We provide commands to implement it, just run the following commands:
+```shell
+make update-license
+make update-mdlint
+make update-gofmt

Review comment:
       got it




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org