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

Use Semantic Versioning for explicit library integration #90

Closed
jserv opened this issue Jan 15, 2019 · 5 comments
Closed

Use Semantic Versioning for explicit library integration #90

jserv opened this issue Jan 15, 2019 · 5 comments
Assignees
Labels
feature Outstanding features we should implement
Milestone

Comments

@jserv
Copy link
Member

jserv commented Jan 15, 2019

Under this scheme Semantic Versioning (SemVer), version numbers and the way they change convey meaning about the underlying code and what has been modified from one version to the next. That is, dcurl using Semantic Versioning MUST declare a public API, and it should treat all of these scenarios in the same way.

Expected output:

  1. Label release versioning;
  2. Release SemVer-friendly package(s);
  3. API documentation specifying SemVer;
@marktwtn
Copy link
Collaborator

Current public API would be:

bool dcurl_init():
Resource allocation.

int8_t dcurl_entry(int8_t *trytes, int mwm, int threads)
Assign a hardware platform, do the PoW and get the result.

void dcurl_destroy():
Resource release.

@wusyong
Copy link

wusyong commented Jan 22, 2019

@marktwtn I think API documentation can simply put in README if thats all. By the way, where will the version number be placed at?

@jserv
Copy link
Member Author

jserv commented Jan 22, 2019

At the moment, we don't have to think of the API compatibility, and some macros in public header would be functional from the perspective of SemVer. That is, something like DCURL_MAJOR and DCURL_MINOR.
Reference: https://gcc.gnu.org/onlinedocs/cpp/Common-Predefined-Macros.html

@jserv jserv added the feature Outstanding features we should implement label Feb 11, 2019
@jserv jserv added this to the sprint-201902 milestone Feb 11, 2019
@marktwtn
Copy link
Collaborator

We already have the version 0.1.0 API document in #115,
and have a tag of v0.1.0 on master branch.

After I finish writing the change log of the version 0.1.0 and create the release, the issue can be closed.

@marktwtn
Copy link
Collaborator

marktwtn commented Mar 2, 2019

The version 0.1.0 has been released!
The issue can be closed now.

@jserv jserv closed this as completed Mar 3, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature Outstanding features we should implement
Projects
None yet
Development

No branches or pull requests

4 participants