![]() To verify that the Fiji components build without problems, and that all regression tests pass, every Fiji project’s source code repository is connected to a GitHub Actions job that builds and tests the source code, and deploys the Maven artifacts, whenever a new revision is made available. This might entail code changes as ImageJ and Fiji evolve. But it is then the project maintainer’s responsibility to ensure the project continues to function properly in up-to-date installations of Fiji. Projects that reside outside the fiji organization are not subject to the requirements above. The master branch is considered release ready at all times, meaning it compiles with passing tests, and is ready for downstream consumption.The Fiji maintainers may make commits and release new versions of the component as needed, so that Fiji as a whole continues to work as intended.The project has a dedicated page here on the ImageJ wiki.The project uses GitHub Issues for issue tracking.Components are versioned according to SemVer.With the standard Maven directory layout.Each component (i.e., JAR file) lives in its own repository.The following criteria apply to projects hosted in the fiji organization: You alone maintain the project (though Fiji maintainers may submit PRs to help). Repository is hosted in a GitHub organization you control. Fiji maintainers help maintain the project. Repository is hosted in the fiji organization, or a descendant organization (e.g., trakem2). There are two possibilities for where to host your project: This ensures continuity and visibility, and facilitates collaboration. Source hosted on GitHubĬore Fiji development takes place on GitHub. Likewise, working with interested parties to improve one’s project will invariably lead to a much better and stronger result.Īs such, components distributed with Fiji must be licensed in a way compatible with the GNU General Public License. refusing to share materials and methods-will invariably have the opposite effect in the long run. Withholding the source code-like any other method to obstruct other researchers’ work, e.g. ![]() There are many corollaries to this wisdom, the most prominent: if you write software in your endeavor to discover new insights, Open Source is the way that brings you farthest. Requirements Freely accessible source code Conversely, if you distribute your extension on a separate update site, this page does not apply. Such projects are subject to the requirements discussed below. DefinitionĪ “core” Fiji project is one distributed on the Fiji update site. The following document describes these requirements, as well as associated best practices, for shipping your component as part of the Fiji update site. However, doing so comes with a few corresponding rules. See the Distribution page for details.ĭistributing your software component as part of Fiji is an effective way to immediately and easily put it into the hands of many users, as well as to actively participate in the community of ImageJ software development. There is another good way to distribute your extension: your own update site.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |