Bugzilla – Full Text Bug Listing
| Summary: | [proposal] locationtech.technology.spatial4j | ||
|---|---|---|---|
| Product: | Community | Reporter: | Wayne Beaton <wayne.beaton> |
| Component: | Proposals and Reviews | Assignee: | Eclipse Management Organization <emo> |
| Status: | RESOLVED FIXED | QA Contact: | |
| Severity: | normal | ||
| Priority: | P3 | CC: | andrea.ross, caniszczyk, denis.roy, dsmiley, richard.burcher, ryantxu, sharon.corbett, wayne.beaton, webmaster |
| Version: | unspecified | ||
| Target Milestone: | --- | ||
| Hardware: | PC | ||
| OS: | Linux | ||
| URL: | https://www.locationtech.org/proposals/spatial4j | ||
| Whiteboard: | |||
| Bug Depends on: | 423195, 433945 | ||
| Bug Blocks: | |||
|
Description
Wayne Beaton
I've posted the proposal for community review. I've requested a trademark review. We have one mentor! Thanks very much for mentoring Chris. Wayne, I'm guessing you're being the 2nd mentor? Thanks again! I'll be mentor #2. I haven't heard back yet regarding the trademark assignment. That needs to be complete before we can take the next step (creation review). The next review period ends on March 5. Trademark approved. Creation review scheduled for June 11. Hi Folks, Your projects creation review has been scheduled. Next Steps for the Project ========================== Project provisioning to provide all the infrastructure and resources for the project. We will take care of provisioning for you once the project is created. Information We Need ------------------- - What type of Git repository does the project want. Github based (under one of the forges) [1] or regular Git repository hosted on Eclipse infrastructure? - If you've selected using a Github repository for the above question, will you be moving an existing Github project? If so please provide the full urls. Interim Work The Project Can Do Before Creation Review ====================================================== Couple of items you can get going on: - Please have your committers create Eclipse accounts [2], then log into [3]. This will help speed up the provisioning teams workflow to get all the projects resources in place quickly. - The new project [4] can begin to assemble the projects initial code contribution [5] to be ready for the Provisioning phase (we undertake this on behalf of the projects now). Before you can make an initial contribution, your project needs to be provisioned. Getting the code ready now will reduce the time to submit the initial contribution once we've provisioned the project. Initial Code Contribution ------------------------- Broadly speaking, the initial code contribution involves: (this is a quick summary of [5]) - Updating the package namespaces to either org.eclipse.<project-name> or org.locationtech.<project-name> depending on the projects forge location. - Ensuring Eclipse copyright and license notices are present. - All required notices are present. - Ensure that no nesting of source files is present. - Identify and remove all third-party party libraries from the source code. Other items to be aware of with the initial code contribution: - Code cannot be pushed to the project's source code repository until after the IP team has approved the initial Contribution. - The initial contribution must be the first commit in your project repository. History must be collapsed into that single commit. - Any third-party libraries required by your code will have to be checked and approved by the IP Team. - Project-licensed content and third-party-licensed content are not reviewed together. Separate Contribution Questionnaires (CQ's) are required. Important: Legal ================ Please familiarize yourself with the IP Due Diligence Process [6] and the Parallel IP Process [7]. As an incubating project you can take advantage of Parallel IP to get moving quicker with development. Project Resources ================= Please have a look at the Development Resources wiki [8] and [9] the EDP process. Your project mentors are an excellent resource if you need guidance. We urge you to make use of their expertise. Cheers, Richard [1] https://wiki.eclipse.org/Social_Coding/Hosting_a_Project_at_GitHub [2] https://dev.eclipse.org/site_login/createaccount.php [3] https://dev.eclipse.org/site_login/ [4] https://wiki.eclipse.org/Development_Resources/HOWTO/Starting_A_New_Project [5] http://wiki.eclipse.org/Development_Resources/initial_Contribution [6] http://www.eclipse.org/legal/EclipseLegalProcessPoster.pdf [7] http://www.eclipse.org/projects/dev_process/parallel-ip-process.php [8] https://wiki.eclipse.org/Development_Resources [9] https://www.eclipse.org/projects/dev_process/development_process.php Spatial4j exists on GitHub, where I'd like it to stay: https://github.com/spatial4j/spatial4j I imagine that you'd like to move it within GitHub to be underneath the /locationtech org. I already have an Eclipse account, and I believe Ryan McKinley does too (?). I reviewed some of the material linked to. I have questions now and surely there will be more. (1) If a contributor, on GitHub, forks and provides a pull request to something less than 250 lines of code (e.g. a bug fix), then do they really have to create a Bugzilla/Gerrit entry linking to it? Presumably this means the contributor needs an account there. I'm asking because I'd like to continue using GitHub's built-in issue tracker without redundant duplication. (2) Will there be a change in copyright? As indicated in the project proposal, it is copyrighted to the ASF (even though it's not an ASF project). (3) Is there a deadline for the "initial code contribution"? Maybe I shouldn't fret it since the pre-LocationTech Spatial4j could get a bug-fix release independent of the new LocationTech one. Congratulations, the project has been successfully created. We will be in touch shortly. Hi Folks, We have initiated the provisioning process for your project. Please watch your email for information and further instructions. This is a multi-step process that requires input from the project committers before we can do much else. Please complete the committer questionnaire and provide the requested committer documentation as soon as possible so that we can push forward. FYI === Let your new committers know that they won't be able to fill in their committer questionnaires until they have received their automated email titled "New Committer Request Form." A "project information" page [1] has been created that you can use to share information about the project with the community. As your committers are provisioned, they will be able to edit the information on this page. Next Steps for the Project ========================== The next step for the project will be the initial code contribution. While you're waiting for provisioning, you can start working on the initial contribution. Initial Code Contribution ------------------------- Broadly speaking, the initial code contribution involves: (this is a quick summary of [2]) - If applicable, update the package namespace. For example for Java based projects [3]. - Ensuring Eclipse copyright, license [4] and "about" notices [5]. - Identify all third-party party libraries. Other items to be aware of with the initial code contribution: - Code cannot be pushed to the project's source code repository until after the IP team has approved the initial Contribution. - The initial contribution must be the first commit in your project repository. History must be collapsed into that single commit [6]. - Any third-party libraries required by your code will have to be checked and approved by the IP Team. - Project-licensed content and third-party-licensed content are not reviewed together. Separate Contribution Questionnaires (CQ's) [7] are required. Important: Legal ================ Please familiarize yourself with the IP Due Diligence Process [8] and the Parallel IP Process [9]. As an incubating project you can take advantage of Parallel IP to get moving quicker with development. Project Resources ================= Please have a look at the Development Resources wiki [10] and [11] the EDP process. Your project mentors are an excellent resource if you need guidance. We urge you to make use of their expertise. Cheers, Richard [1] https://www.locationtech.org/projects/locationtech.spatial4j [2] http://wiki.eclipse.org/Development_Resources/initial_Contribution [3] https://wiki.eclipse.org/Development_Resources/HOWTO/The_Eclipse_Code_Namespace_Policy [4] https://www.eclipse.org/legal/copyrightandlicensenotice.php [5] https://www.eclipse.org/legal/epl/about.php [6] https://wiki.eclipse.org/Social_Coding/Hosting_a_Project_at_GitHub#Collapsing_History [7] https://wiki.eclipse.org/Development_Resources/Contribution_Questionnaire [8] http://www.eclipse.org/legal/EclipseLegalProcessPoster.pdf [9] http://www.eclipse.org/projects/dev_process/parallel-ip-process.php [10] https://wiki.eclipse.org/Development_Resources [11] https://www.eclipse.org/projects/dev_process/development_process.php (In reply to David Smiley from comment #9) > Spatial4j exists on GitHub, where I'd like it to stay: > https://github.com/spatial4j/spatial4j > I imagine that you'd like to move it within GitHub to be underneath the > /locationtech org. > > I already have an Eclipse account, and I believe Ryan McKinley does too (?). > > I reviewed some of the material linked to. I have questions now and surely > there will be more. > > (1) If a contributor, on GitHub, forks and provides a pull request to > something less than 250 lines of code (e.g. a bug fix), then do they really > have to create a Bugzilla/Gerrit entry linking to it? Presumably this means > the contributor needs an account there. I'm asking because I'd like to > continue using GitHub's built-in issue tracker without redundant duplication. > > (2) Will there be a change in copyright? As indicated in the project > proposal, it is copyrighted to the ASF (even though it's not an ASF project). > > (3) Is there a deadline for the "initial code contribution"? Maybe I > shouldn't fret it since the pre-LocationTech Spatial4j could get a bug-fix > release independent of the new LocationTech one. Hi David, In regards to (1 & 3) pull requests are ok, but the contributor needs a CLA [1], [2]. Please have a look at [3] that gives me details about contributions via git. We verify this with hooks [4] we've implemented. Project bugs need to be tracked in our bugzilla instance [5]. There is no deadline for the initial contribution but I would strongly recommend getting it assembled and submitted to the IP Team. //Wayne: Can you please discuss item (2). Cheers, Richard [1] https://wiki.eclipse.org/CLA [2] https://www.eclipse.org/legal/CLA.php [3] https://wiki.eclipse.org/Development_Resources/Contributing_via_Git [4] https://wiki.eclipse.org/Social_Coding/Hosting_a_Project_at_GitHub#GitHub_Hooks [5] https://bugs.eclipse.org/ (In reply to David Smiley from comment #9) > (2) Will there be a change in copyright? As indicated in the project > proposal, it is copyrighted to the ASF (even though it's not an ASF project). This is more of a Sharon question... I've emailed David to discuss the matter as there could be some back and forth. Thanks, Sharon David and I have discussed. The project's initial code contribution may be provided as is. Thanks, Sharon Project has been provisioned. Hi Folks, The project has now been provisioned. Next Steps for the Project ========================== The next step for the project will be the initial code contribution. We use a modified version of Bugzilla that we call IPZilla [1] intellectual property contributions for projects. This is only accessible to committers. Individual contribution records are called Contribution Questionnaire (CQ's) [2] . A CQ is required for the projects initial contribution and all third party libraries. Broadly speaking, the initial code contribution involves: (this is a quick summary of [3]) - If applicable, update the package namespace. For example for Java based projects [4]. - Ensuring Eclipse copyright, license [5] and "about" notices [6]. - Identify all third-party party libraries. Other items to be aware of with the initial code contribution: - Code cannot be pushed to the project's source code repository until after the IP team has approved the initial Contribution. - The initial contribution must be the first commit in your project repository. History must be collapsed into that single commit [7]. - Any third-party libraries required by your code will have to be checked and approved by the IP Team. - Project-licensed content and third-party-licensed content are not reviewed together. Separate Contribution Questionnaires (CQ's) [3] are required. Important: Legal ================ Please familiarize yourself with the IP Due Diligence Process [8] and the Parallel IP Process [9]. As an incubating project you can take advantage of Parallel IP to get moving quicker with development. Project Resources ================= Please have a look at the Development Resources wiki [10] and [11] the EDP process. Your project mentors are an excellent resource if you need guidance. We urge you to make use of their expertise. Thanks and let me know if you have any questions, Richard [1] https://wiki.eclipse.org/IPzilla [2] https://wiki.eclipse.org/Development_Resources/Contribution_Questionnaire [3] http://wiki.eclipse.org/Development_Resources/Initial_Contribution [4] https://wiki.eclipse.org/Development_Resources/HOWTO/The_Eclipse_Code_Namespace_Policy [5] https://www.eclipse.org/legal/copyrightandlicensenotice.php [6] https://www.eclipse.org/legal/epl/about.php [7] https://wiki.eclipse.org/Social_Coding/Hosting_a_Project_at_GitHub#Collapsing_History [8] http://www.eclipse.org/legal/EclipseLegalProcessPoster.pdf [9] http://www.eclipse.org/projects/dev_process/parallel-ip-process.php [10] https://wiki.eclipse.org/Development_Resources [11] https://www.eclipse.org/projects/dev_process/development_process.php I'm going to try and do the initial contribution this week. As already mentioned, this is hosted on GitHub. I'd like to *move* the GitHub project within GitHub to the LocationTech org that is already there, as opposed to creating a new project on GitHub from scratch. In doing so, anybody who has forked or cloned the repo, or who has "starred" the repo; it will be maintained. And GitHub has redirects as well. Once there, I could rename the master branch to "spatial4j.com_master" or some-such, and then create a new branch to hold the initial contribution named "master", but one without a parent. Without a parent, it will be the first commit of the branch and a user won't be able to do a "git log" to see renames and other history). If a user wants to see prior stuff, they would have to know to go to one of the other branches (very atypical). Would this be fine? It would help if whoever approves/denies this has experience with GitHub and knows what I'm talking about. Hi David, Once the IP Team has given check-in permission for the initial code contribution, we can begin the process of moving repositories. The Webmaster team is well versed in doing this. Please take a look at the following links, in particularly [1] that describes in detail migrating a GitHub repo to the Eclipse (LocationTech) GitHub organization. [1] https://wiki.eclipse.org/GitHub [2] https://wiki.eclipse.org/Social_Coding/Hosting_a_Project_at_GitHub [3] https://wiki.eclipse.org/Development_Resources/HOWTO/Starting_A_New_Project#Background Hi David, I should further mention that when we take ownership of your existing GitHub repository will we squash all code and history into an obscure branch. The initial code contribution you submit when approved will become the first commit into the new GitHub repository at LocationTech. //Webmaster if I've missed anything or further items need to be clarified, please jump in. Richard pretty much summed it up. The actual process we follow when moving a repo: https://wiki.eclipse.org/GitHub (A) I'm a little stuck developing the initial contribution. According to Eclipse's procedures, I am to add a notice.html file copied from http://www.eclipse.org/legal/epl/notice.html However this notice as-written isn't applicable for several reasons: 1. Eclipse granted me approval to maintain its copyright to the Apache Software Foundation (not Eclipse) and to maintain its sole use of the ASL license (not EPL). 2. This project is not modularized into smaller pieces ("Feature" / Plug-In); it's all or nothing. It's fairly small. 3. Spatial4j isn't available via "Provisioning Technology". In short, Spatial4j is not a plug-in to the Eclipse IDE yet this notice.html seems tailored for such things. 4. There is no cryptography. (B) Related to this, I have a question about headers. You can see an example of the current header applied to all source files here: https://github.com/spatial4j/spatial4j/blob/master/pom.xml Is this an appropriate header going forward or should it be changed at all? It seems fine. It's the same header used on ASF run projects (even though it's not an ASF run project). (C) Should there be official references to an *optional* dependency of Spatial4j -- JTS to include JTS's LGPL license? It is not distributed with Spatial4j; a user must explicitly either download it or declare it as a dependency via maven or similar. Furthermore, there are a few dependencies used during testing alone. Hi David: Thanks very much for checking. Indeed good points as Spatial4j's situation is not typical. Having said that, please go ahead and raise the Initial CQ using the header you've indicated. Regarding the other required legal documentation, we (IP Team) will work on that for you in parallel and provide you with the necessary Notice, Abouts, etc. to include with the project's initial commit. Regards, Sharon Corbett Intellectual Property I found the new Bugzilla project created for Spatial4j (after a little hunting around) and I added the "Initial Contribution": https://locationtech.org/bugs/show_bug.cgi?id=22 According to the next step, I am to file a "Contribution Questionnaire" somewhere here: http://portal.eclipse.org/ but I can't find it :-( (In reply to David Smiley from comment #24) > According to the next step, I am to file a "Contribution Questionnaire" > somewhere here: http://portal.eclipse.org/ but I can't find it :-( I just went through this process myself so maybe I can help. After logging into the portal. 1. Look for the "Eclipse Projects" box * It will list all the projects you're committer as well as Project Lead for. 2. Click View for the project you're project lead for * It will open a new page that lists things you can do 3. Look for the list under IP Policy (Contribution Questionnaire) 4. Click the link "[Contribution]" Hope this helps. initial code contribution submitted. Hi Folks, Besides raising [1] a Contribution Questionnaire (CQ's) for the projects initial code contribution, you must also raise CQ's for every third-party library [2] that your project code makes direct use of. Please review our guidelines for 3rd Party Dependencies [3]. Please first discuss with your Mentors and/or PMC if you have any questions. Thanks and let me know if you have any questions, Richard [1] https://wiki.eclipse.org/Project_Management_Infrastructure/Creating_A_Contribution_Questionnaire [2] https://wiki.eclipse.org/Development_Resources/Contribution_Questionnaire#Third_Party_Libraries [3] https://www.eclipse.org/org/documents/Eclipse_Policy_and_Procedure_for_3rd_Party_Dependencies_Final.pdf Hi Folks, Quick reminder to submit your 3rd party CQ's if the project is using them. Please see comment 27. Office hours are tomorrow (Sept 4th), drop by if you have any questions https://wiki.eclipse.org/Evangelism/Office_Hours. Have a good one, Richard Project creation is complete, so I'm closing this bug. Please do not hesitate to contact your project mentors or me for assistance. |