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

exp/services/ledgerexporter: Add guide for contributors/developers #5340

Merged
merged 11 commits into from
Jun 27, 2024

Conversation

urvisavla
Copy link
Contributor

@urvisavla urvisavla commented Jun 11, 2024

PR Checklist

PR Structure

  • This PR has reasonably narrow scope (if not, break it down into smaller PRs).
  • This PR avoids mixing refactoring changes with feature changes (split into two PRs
    otherwise).
  • This PR's title starts with name of package that is most changed in the PR, ex.
    services/friendbot, or all or doc if the changes are broad or impact many
    packages.

Thoroughness

  • This PR adds tests for the most critical parts of the new functionality or fixes.
  • I've updated any docs (developer docs, .md
    files, etc... affected by this change). Take a look in the docs folder for a given service,
    like this one.

Release planning

  • I've updated the relevant CHANGELOG (here for Horizon) if
    needed with deprecations, added features, breaking changes, and DB schema changes.
  • I've decided if this PR requires a new major/minor version according to
    semver, or if it's mainly a patch change. The PR is targeted at the next
    release branch if it's not a patch change.

What

Add a guide for developers and contributors to complement the Installation and Usage guide.

Why

Fixes HUBBLE-457

Known limitations

@urvisavla urvisavla force-pushed the HUBBLE-457/lexie-dev-guide branch from 5789124 to ef18110 Compare June 12, 2024 00:25
Copy link
Contributor

@sreuland sreuland left a comment

Choose a reason for hiding this comment

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

lgtm!

@urvisavla urvisavla force-pushed the HUBBLE-457/lexie-dev-guide branch 2 times, most recently from 20a110d to bf2c976 Compare June 27, 2024 03:33
urvisavla and others added 6 commits June 27, 2024 09:51
Co-authored-by: shawn <sreuland@users.noreply.github.com>
Co-authored-by: shawn <sreuland@users.noreply.github.com>
Co-authored-by: shawn <sreuland@users.noreply.github.com>
Co-authored-by: shawn <sreuland@users.noreply.github.com>
@urvisavla urvisavla force-pushed the HUBBLE-457/lexie-dev-guide branch from bf2c976 to 723c690 Compare June 27, 2024 17:19
@urvisavla urvisavla changed the title exp/services/ledgerexporter: Initial draft of developer guide exp/services/ledgerexporter: Add guide for contributors/developers Jun 27, 2024
@urvisavla urvisavla marked this pull request as ready for review June 27, 2024 18:25
Copy link
Contributor

@Shaptic Shaptic left a comment

Choose a reason for hiding this comment

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

Nice! 👏 I just added some minor notes about typos and cross-references 👍

exp/services/ledgerexporter/DEVELOPER_GUIDE.md Outdated Show resolved Hide resolved
exp/services/ledgerexporter/DEVELOPER_GUIDE.md Outdated Show resolved Hide resolved
exp/services/ledgerexporter/DEVELOPER_GUIDE.md Outdated Show resolved Hide resolved
urvisavla and others added 4 commits June 27, 2024 14:51
Co-authored-by: George <Shaptic@users.noreply.github.com>
Co-authored-by: George <Shaptic@users.noreply.github.com>
Co-authored-by: George <Shaptic@users.noreply.github.com>
@urvisavla urvisavla merged commit 6fbc6e0 into stellar:master Jun 27, 2024
23 checks passed
@urvisavla urvisavla deleted the HUBBLE-457/lexie-dev-guide branch June 27, 2024 22:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants