Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

AVRO-2175: Fix build scripts and instructions #1563

Merged
merged 2 commits into from Feb 25, 2022

Conversation

RyanSkraba
Copy link
Contributor

It should be a priority for contributors to build and test the new website locally. This PR updates the build script and provides some local development instructions.

Jira

Tests

  • My PR does not need testing for this extremely good reason: Manual build instructions.

Commits

  • My commits all reference Jira issues in their subject lines. In addition, my commits follow the guidelines from "How to write a good git commit message":
    1. Subject is separated from body by a blank line
    2. Subject is limited to 50 characters (not including Jira issue reference)
    3. Subject does not end with a period
    4. Subject uses the imperative mood ("add", not "adding")
    5. Body wraps at 72 characters
    6. Body explains "what" and "why", not "how"

Documentation

  • In case of new functionality, my PR adds documentation that describes how to use it.
    • All the public functions and the classes in the PR contain Javadoc that explain what it does

doc/README.md Outdated Show resolved Hide resolved
@RyanSkraba RyanSkraba merged commit e4f629c into apache:master Feb 25, 2022
@RyanSkraba RyanSkraba deleted the rskraba/AVRO-2175-build-dist branch February 25, 2022 11:14
RyanSkraba added a commit that referenced this pull request Feb 25, 2022
* AVRO-2175: Fix build scripts and instructions

* Update README.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants