search

alan-turing-institute / DTBase

A starting point from which digital twins can be developed.
MIT License
11 stars 4 forks source link

Add a guide for contributing to code #122

Open EdwinB12 opened 12 months ago

EdwinB12 commented 12 months ago

We should come up with official workflow for contributing to the repository. A diagram would then be nice. Maybe built in mermaid. Example below:

https://github.com/RSE-Sheffield/RSEAdmin - Something like the diagram here.

@mhauru - Did we agree on a contributing policy? I.e. Dev branch? Probabaly need to think about how this works with the forks for specific branches we're going to have moving forward.

mhauru commented 12 months ago

I'd be happy to either copy that RSEAdmin diagram and paragraph verbatim, or just simplify it by removing the dev/main distinction. I think that distinction is very good if we ever have a production deployment of DTBase, but for now it's unnecessary, and I wonder if in the future all the production deployments will come from user-specific forks anyway.

EdwinB12 commented 12 months ago

Hmm yes as DTBase is really going to act as a template more than anything, then yes I agree dev branch seems a little silly. .

This may happen organically, but it would be good to step through the process of making a change to dtbase, and that change being updated on a fork of dtbase and how we would scope whether this would break the fork.