[SPARK-35140] Establish error message guidelines

• Type: Improvement
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 3.1.0
• Fix Version/s: 3.2.0
• Component/s: Spark Core, SQL
• Assignee: Karen Feng
• Reporter: Karen Feng
• Created: 19/Apr/21 21:15
• Updated: 12/Dec/22 18:10
• Resolved: 21/Apr/21 12:35

Description

In the SPIP: Standardize Exception Messages in Spark, there are three major improvements proposed:

1. Group error messages in dedicated files.
2. Establish an error message guideline for developers.
3. Improve error message quality.

The second step is to establish the error message guideline. This was discussed in http://apache-spark-developers-list.1001551.n3.nabble.com/DISCUSS-Build-error-message-guideline-td31076.html and added to the website in https://github.com/apache/spark-website/pull/332. To increase visibility, the guidelines should be accessible from the PR template.

Issue Links

• links to: [Github] Pull Request #32241 (karenfeng)