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

add contributor information #44

Closed
10 tasks
bvreede opened this issue Nov 1, 2021 · 1 comment · Fixed by #43
Closed
10 tasks

add contributor information #44

bvreede opened this issue Nov 1, 2021 · 1 comment · Fixed by #43

Comments

@bvreede
Copy link
Member

bvreede commented Nov 1, 2021

  • Project organization (+ brief summaries) in the main README
    • Link to contribution guide
    • Citation info
  • (basic) Information about current notebooks into the python/README
  • Contributor information:
    • Generate a new script: where and how
    • Where to put the output image
    • Make internal changes to the project (i.e. what to update when adding a new script)
    • Rendering the atlas locally
    • Adding/changing javascript pages
@bvreede bvreede linked a pull request Nov 1, 2021 that will close this issue
@bvreede
Copy link
Member Author

bvreede commented Nov 1, 2021

Should we put information about contributions in its own CONTRIBUTING.md file in root? This would keep the main page of the repository clean but keep the information findable in a logical place. We are adding the info to the main README right now, but we would like your input about its location. (just moved it to CONTRIBUTING.md -- still happy with input though!)

@bvreede bvreede changed the title concentrate all developer info to a single README file add contributor information Nov 1, 2021
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

Successfully merging a pull request may close this issue.

1 participant