diff --git a/community.html b/community.html index 6ac78a1..aae7f6c 100644 --- a/community.html +++ b/community.html @@ -90,25 +90,25 @@ - + -

+

caMicroscope is open source software. Much of its development has been ad-hoc towards particular project needs. Thanks to community support, caMicroscope is able to be a general tool, in addition to these specific use cases.

-

+

The clearest and most structured way in which the community supports caMicroscope's and its scientific missions is through Google Summer of Code (GSOC). This program allows for contributors to recieve a stipend and formal acknowledgment for open source contributions.

-

+

caMicroscope can be a difficult project to onboard onto. Since it is a distributed platform, development of the components occurs in different repositories. The best starting place is the distribution repository, which has a docker-compose container manifest for comparatively easy deployment of the platform all at once. For development purposes, we have a special manifest, develop.yml, which disables some security features, and uses edge code. From there, use the UI, which detaults to port 4010) to load an image.

-

+

We Use Github Flow, So All Code Changes Happen Through Pull Requests. Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests. We do not typically assign pull requests without a reason why a particular person should do the work.

-

+

As a general a open source quality of life improvement, we recommend working on topic branches off of your fork, and keeping your master/develop up to date with the upstream repositories. There's a guide to triangle workflows which may be helpful for using git this way.

-

+

Issues and pull requests should be against the most relevant repository (i.e. where the change would take place). Great Bug Reports tend to have:
A quick summary and/or background