I've created a PR to add the error message guidelines to the Spark contributing guide. Would appreciate some eyes on it! https://github.com/apache/spark-website/pull/332
On Wed, Apr 14, 2021 at 5:34 PM Yuming Wang <wgy...@gmail.com> wrote: > +1 LGTM. > > On Thu, Apr 15, 2021 at 1:50 AM Karen <karenfeng...@gmail.com> wrote: > >> That makes sense to me - given that an assert failure throws an >> AssertException, I would say that the same guidelines should apply for >> asserts. >> >> On Tue, Apr 13, 2021 at 7:41 PM Yuming Wang <wgy...@gmail.com> wrote: >> >>> Do we have plans to apply these guidelines to assert? For example: >>> >>> >>> https://github.com/apache/spark/blob/5b478416f8e3fe2f015af1b6c8faa7fe9f15c05d/sql/core/src/main/scala/org/apache/spark/sql/execution/datasources/orc/OrcUtils.scala#L136-L138 >>> >>> https://github.com/apache/spark/blob/053dd858d38e6107bc71e0aa3a4954291b74f8c8/sql/core/src/main/scala/org/apache/spark/sql/execution/datasources/v2/DataSourcePartitioning.scala#L41 >>> >>> On Wed, Apr 14, 2021 at 9:27 AM Hyukjin Kwon <gurwls...@gmail.com> >>> wrote: >>> >>>> I would just go ahead and create a PR for that. Nothing written there >>>> looks unreasonable. >>>> But probably it should be best to wait a couple of days to make sure >>>> people are happy with it. >>>> >>>> 2021년 4월 14일 (수) 오전 6:38, Karen <karenfeng...@gmail.com>님이 작성: >>>> >>>>> If the proposed guidelines look good, it would be useful to share >>>>> these guidelines with the wider community. A good landing page for >>>>> contributors could be https://spark.apache.org/contributing.html. >>>>> What do you think? >>>>> >>>>> Thank you, >>>>> >>>>> Karen Feng >>>>> >>>>> On Wed, Apr 7, 2021 at 8:19 PM Hyukjin Kwon <gurwls...@gmail.com> >>>>> wrote: >>>>> >>>>>> LGTM (I took a look, and had some offline discussions w/ some >>>>>> corrections before it came out) >>>>>> >>>>>> 2021년 4월 8일 (목) 오전 5:28, Karen <karenfeng...@gmail.com>님이 작성: >>>>>> >>>>>>> Hi all, >>>>>>> >>>>>>> As discussed in SPIP: Standardize Exception Messages in Spark ( >>>>>>> https://docs.google.com/document/d/1XGj1o3xAFh8BA7RCn3DtwIPC6--hIFOaNUNSlpaOIZs/edit?usp=sharing), >>>>>>> improving error message quality in Apache Spark involves establishing an >>>>>>> error message guideline for developers. Error message style guidelines >>>>>>> are >>>>>>> common practice across open-source projects, for example PostgreSQL ( >>>>>>> https://www.postgresql.org/docs/current/error-style-guide.html). >>>>>>> >>>>>>> To move towards the goal of improving error message quality, we >>>>>>> would like to start building an error message guideline. We have >>>>>>> attached a >>>>>>> rough draft to kick off this discussion: >>>>>>> https://docs.google.com/document/d/12k4zmaKmmdm6Pk63HS0N1zN1QT-6TihkWaa5CkLmsn8/edit?usp=sharing >>>>>>> . >>>>>>> >>>>>>> Please let us know what you think should be in the guideline! We >>>>>>> look forward to building this as a community. >>>>>>> >>>>>>> Thank you, >>>>>>> >>>>>>> Karen Feng >>>>>>> >>>>>>
