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

Finalize instructional information for authors on how to use this material #1

Closed
10 tasks done
davidlmobley opened this issue Aug 15, 2017 · 2 comments
Closed
10 tasks done
Assignees
Labels

Comments

@davidlmobley
Copy link
Contributor

davidlmobley commented Aug 15, 2017

@mrshirts - I think I volunteered to curate the GitHub side of things. Any thoughts on what I should be doing on here? Things that come to mind offhand are:

Basic repo:

  • Make sure there are good README's explaining what this is about, linking to journal, etc.
  • Make sure there are examples of using the template (the template itself provides one; we can add more later)

In a new "paper writing as code development" document:

  • Likewise give some brief explanations of "paper-writing as code development" and why

In some instructional documents (here or somewhere else? Update: I like here for things which should get attached to their repo, which will be quite a few of these), deal with GitHub practicalities for authors:

  • Explain how authors should set up their GitHub repo (protecting master, enabling issue tracker, etc.)
  • Explain how to handle versioning and dates of changes
  • Explain how to do a release
  • Explain the branch-pull-merge/fork-pull-merge models
  • Have them protect master
  • Give LaTeX formatting tips for easier handling of revisions on GitHub (e.g. one sentence per line)
  • Give concrete examples of specific scenarios and handling via GitHub

What else am I missing?

I've added several of the above in #1 (some PR, not that one).

@davidlmobley davidlmobley changed the title What should I be doing on here? Discuss what needs to be deposited here and how it should be organized Aug 15, 2017
@mrshirts
Copy link
Contributor

Updated a bit in #8

@davidlmobley davidlmobley self-assigned this Nov 23, 2017
@davidlmobley davidlmobley changed the title Discuss what needs to be deposited here and how it should be organized Finalize instructional information for authors on how to use this material Nov 23, 2017
@davidlmobley davidlmobley added this to the open for submissions milestone Nov 23, 2017
@davidlmobley
Copy link
Contributor Author

Closed by #42

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

No branches or pull requests

2 participants