Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

GitHub workflow in dev docs? #45

Open
agladstein opened this issue Feb 1, 2021 · 6 comments
Open

GitHub workflow in dev docs? #45

agladstein opened this issue Feb 1, 2021 · 6 comments

Comments

@agladstein
Copy link
Member

I love the GitHub workflow docs in stdpopsim. I refer to it ALL THE TIME. Can we either reference to it in the msprime dev docs or copy it over to the msprime dev docs? Some new msprime contributors might not know that it exists over on stdpopsim.

@jeromekelleher
Copy link
Member

What if we added a "Developers" part to the tutorials website and put an updated version of our Git workflow there? It would be nice to get some of the stuff that is common to different projects in there.

Or we could reference the stdpopsim one for now, as a quickfix as you suggest.

@agladstein
Copy link
Member Author

hmm... Could be a good resource to have common development standards across the project in one place. But, I'm not sure about it. I'd want to hear what other people thing about it.

@agladstein
Copy link
Member Author

@cdquinto what do you think?

@cdquinto
Copy link

cdquinto commented Feb 7, 2021

I would prefer to have the updated Git workflow in the msprime tutorials than having a link to the stdpopsim one.

@agladstein
Copy link
Member Author

Okay, unless anyone else has opinions, let's make a "Developers" part in the tutorials and include the GitHub workflow. @jeromekelleher can you do the fancy move this issue over to the tutorials repo? Or I can just close this and open an issue over there.

@benjeffery benjeffery transferred this issue from tskit-dev/msprime Feb 8, 2021
@hyanwong
Copy link
Member

hyanwong commented Dec 8, 2021

I'm not sure this belongs on the "tutorials" site, but we do have the workflow in the tskit docs, at https://tskit.dev/tskit/docs/stable/development.html#git-workflow. Can we point there from msprime and close this issue @agladstein, do you think?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants