Skip to content

fix: rename helpers #51

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

Merged
merged 8 commits into from
Jan 28, 2019
Merged

fix: rename helpers #51

merged 8 commits into from
Jan 28, 2019

Conversation

sleepdefic1t
Copy link
Contributor

Proposed changes

Cpp-Crypto uses the header 'helpers/helpers.h'.
Cpp-Client also uses this 'helpers/helpers.h' naming.
These headers are not identical and contain only “helper” functions specific to its library.

When both Cpp-Client & Cpp-Crypto are included in the same project, it results in one of the headers being dropped.

This PR renames 'helpers/helpers.h' to 'helpers/crypto_helpers.h’, and resolves the name collision.

Types of changes

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Refactoring (improve a current implementation without adding a new feature or fixing a bug)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Build (changes that affect the build system)
  • Docs (documentation only changes)
  • Test (adding missing tests or fixing existing tests)
  • Other... Please describe:

Checklist

  • I have read the CONTRIBUTING documentation
  • Lint and unit tests pass locally with my changes
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)

Further comments

There will also be a PR in ArkEcosystem/Cpp-Client to match this revised naming.

Cpp-Crypto uses the header 'helpers/helpers.h'.
Cpp-Client also uses this 'helpers/helpers.h' naming.
These headers are not identical and contain only “helper” functions specific to its library.

When both Cpp-Client & Cpp-Crypto are included in the same project, it results in a name collision causing one of the headers to be dropped.

This PR renames 'helpers/helpers.h' to 'helpers/crypto_helpers.h’, and resolves the name collision.
@sleepdefic1t
Copy link
Contributor Author

ArkEcosystem/cpp-client #51 matches this revised naming.

@sleepdefic1t
Copy link
Contributor Author

Failing Linux build also showed up in #50 and is unrelated to these changes.

@sleepdefic1t
Copy link
Contributor Author

#52 should resolve failing linux build.

@faustbrian faustbrian merged commit 0152612 into ArkEcosystemArchive:master Jan 28, 2019
@sleepdefic1t sleepdefic1t mentioned this pull request Feb 5, 2019
12 tasks
@sleepdefic1t sleepdefic1t deleted the fix/rename-helpers branch February 15, 2019 17:54
ciband pushed a commit to ciband/cpp-crypto that referenced this pull request Feb 18, 2019
Cpp-Crypto uses the header 'helpers/helpers.h'.
Cpp-Client also uses this 'helpers/helpers.h' naming.
These headers are not identical and contain only “helper” functions specific to its library.

When both Cpp-Client & Cpp-Crypto are included in the same project, it results in a name collision causing one of the headers to be dropped.

This PR renames 'helpers/helpers.h' to 'helpers/crypto_helpers.h’, and resolves the name collision.
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.

2 participants