Update java-tron.md#599
Open
GordonLtron wants to merge 1 commit into
Open
Conversation
Terminology Standardization: Updated "SuperNode" to Super Representative (SR) to match the official TRON network nomenclature. Changed "Complex Changes" to "Major Changes" to better categorize architectural or breaking modifications. Replaced "improvement" with "enhancement" for a more professional technical tone. Technical Grammar & Phrasing: Git-Flow Prescision: Fixed phrasing from "Based on the standard" to "Based on the develop branch" to ensure contributors use the correct integration point. Verb Tense: Corrected "it can runs" to "it executes" or "it runs" to fix subject-verb agreement. Imperative Mood: Standardized the commit message section to use the imperative mood (e.g., "fix" instead of "fixed"), following Git best practices. Clarity & Readability: Branch Roles: Clarified that the develop branch accepts merges exclusively from contributor forks and release-* branches. TIP Process: Strengthened the requirement for submitting a TRON Improvement Proposal (TIP) for major logic changes before starting code development. CI/CD Visibility: Explicitly listed Sonar and Travis CI as mandatory checks for code quality and static analysis. Formatting Improvements: Converted long, descriptive paragraphs into scannable bullet points. Added standard Markdown syntax highlighting to all Git command examples (e.g., git merge upstream/develop --no-ff). Standardized the Conventional Commits format (e.g., feat(scope): subject) for better automated changelog support.
vivian1912
reviewed
May 20, 2026
| ### Feature Validation | ||
| - **Bug Fix PRs** | ||
| - Reviewers should attempt to reproduce the issue and verify the fix. | ||
| - **For Bug Fixess** |
vivian1912
reviewed
May 20, 2026
| Refer to the [TIP Specification](tips.md). | ||
| - **Early PR Submission** | ||
| We encourage developers to submit PRs early, even if the feature is not yet complete. This allows other developers to know that the related TIP Issue has entered the *In Progress* state. | ||
| We encourage developers to submit PRs early, even if the feature is not yet complete. This notifying the community that the associated TIP has transitioned to the 'In Progress' stage. |
Contributor
There was a problem hiding this comment.
This notifies the community that the associated TIP issue has entered the In Progress state.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR improves the grammar, clarity, and professional tone of the java-tron Developer Guide. No core processes were changed; the updates strictly focus on readability and standardizing technical terminology.
Key Improvements:
Contribution Process & Submission Rules:
Refined introductory phrasing (e.g., changing "significant feature improvement" to "major feature enhancement").
Clarified the "Modify Code" step to explicitly state creating a branch based on the develop branch rather than "the standard".
Improved the flow of the "Early PR Submission" section regarding notifying developers about the In Progress state of TIP issues.
Branch Management:
Polished the descriptions for develop, master, release-, feature-, and hotfix-* branches for grammatical consistency (e.g., changing "Only allows merging" to "Accepts merges only from").
Code Submission Process:
Improved the inline explanations for Git commands, specifically clarifying how the --no-ff flag ensures a clear commit history during the Sync Upstream Code step.
Code Review & Specifications:
Fixed sentence structure in the "Review Process" and "Feature Validation" sections to clearly separate responsibilities for Bug Fixes vs. New Features.
Commit Message Specifications:
Corrected the grammatical instruction for subject lines: changed "first-person present tense" to the industry-standard "imperative mood" (e.g., change, not changed).
Ensured the type(scope): subject formatting rules (max 50 chars, lowercase start, no period) are clearly bulleted.