Skip to content

HDDS-6994. Update Contributing guide#3593

Merged
adoroszlai merged 9 commits into
apache:masterfrom
adoroszlai:HDDS-6994
Jul 14, 2022
Merged

HDDS-6994. Update Contributing guide#3593
adoroszlai merged 9 commits into
apache:masterfrom
adoroszlai:HDDS-6994

Conversation

@adoroszlai

Copy link
Copy Markdown
Contributor

What changes were proposed in this pull request?

  • Maven 3.6 required for frontend-maven-plugin 1.12.0
  • Omit blockade as requirement, move link to blockade-specific README
  • Robot and Hugo are installed by test scripts on-demand (HDDS-4969, HDDS-6512), no need to manually install
  • Remove duplicate docker-compose requirement
  • Avoid mvn install (installing Ozone into local repo may hide build errors)
  • Prefer run.sh over docker-compose command in ozone compose environment
  • Improve contribution workflow (some more detailed steps)
  • Remove mention of advanced docker-related Maven profiles
  • Describe check scripts
  • Document bad class file problem encountered in IDEA

https://issues.apache.org/jira/browse/HDDS-6994

How was this patch tested?

👀

@adoroszlai adoroszlai self-assigned this Jul 13, 2022
@adoroszlai adoroszlai added the documentation Improvements or additions to documentation label Jul 13, 2022

@swagle swagle left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1 LGTM

@adoroszlai
adoroszlai merged commit 912ff42 into apache:master Jul 14, 2022
@adoroszlai
adoroszlai deleted the HDDS-6994 branch July 14, 2022 11:29
@adoroszlai

Copy link
Copy Markdown
Contributor Author

Thanks @swagle for the review.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants