apache / uima-uimacpp

C++ support for Apache UIMA
https://uima.apache.org/
Apache License 2.0
15 stars 19 forks source link

Attempt to separate python annotator from Python extension #16

Closed tmjoris closed 6 months ago

tmjoris commented 7 months ago

JIRA Ticket: https://issues.apache.org/jira/browse/UIMA-XXXX

What's in the PR

How to test manually

Automatic testing

Documentation

Organizational

tmjoris commented 7 months ago

@DrDub have a look at the PR and tell me where it can be enhanced, I am adding you as an editor into my proposal today hope it's not too late. This is the PR in relation to problem #8, and yes I had success building the SDK with your improved documentation

DrDub commented 7 months ago

Hi! I feel there was some miscommunication, I wasn't expecting you to work on this. But if it does work it will be fantastic :-)

I see the template needs editing to refer to the GitHub issues rather than the JIRA ticket.

This will take me a while to review.

From the top of it, why are you working on a "changes" folder? That seems wrong.

Have you ever signed a ICLA with the foundation? https://www.apache.org/licenses/contributor-agreements.html (put to notify the UIMA project if you do). If you have an employer that might need a CCLA but I'll need to check for that, too.

I'll have to check whether this contribution requires one (most probably all of them do).

DrDub commented 7 months ago

I got further clarification in the mailing list. You won't need ICLA for this particular pull request, it is covered by Sec. 5 from the Apache License.

reckart commented 7 months ago

You can still provide an ICLA though - it will facilitate further contributions to this or other projects at the ASF.

tmjoris commented 7 months ago

@DrDub, @reckart I found the ICLA in a link in the site provided earlier, should I sign it now and send to secretary@apache.org

tmjoris commented 7 months ago

And also I am planning on modifying my GitHub actions for the Docker image, just got notified that I'm using a deprecated version of node. That rendered it unable to run

reckart commented 7 months ago

@tmjoris ICLAs should be sent only to the secretary. In particular, do not post a CLA to github or public mailing lists to avoid sharing Personal Identifiable Information (PII). Make sure to mention the UIMA project on the ICLA so that the secretary can notify us about the filed ICLA. Also please mention your GitHub ID is mentioned on the ICLA even if there is no field for it on the ICLA form - in particular if your GitHub ID differs from any Apache ID you might request.

reckart commented 7 months ago

General advice: when you create a pull request, make sure to create a branch in your forked repo first, e.g. refactoring/16-Attempt-to-separate-python-annotator-from-Python-extension make your changes on that branch and then open the PR for that branch. That allows you to work on multiple contributions in parallel and makes things more convenient for maintainers / collaborators to work with your branch (e.g. it will not conflict with the main branch in our own clones).

Look at how commit messages are in general written in the repo and apply the same style when writing your own messages. E.g. we typically use a format like:

Issue #NUMBER: ISSUE TITLE

- change 1
- change 2
- change 3
- ...

Check that the commit author name is properly configured in your git to include your name and email address. If you use multiple computers, check that all of them are configured in the same way. In particular, the name and mail address should match the information from the ICLA.

tmjoris commented 7 months ago

thanks @reckart Your advice and instructions are noted