This is the contribute.md of 52°North best practice document Publishing Research Softwas as Open Source on GitHub. Great to have you here! Here are a few ways you can help!

Contribute.md

Spreading the work

You like the best practice and it helped you? Great! Please talk about it:

  • On Twitter, using the hashtag #pubopen @fivetwon.
  • In your blog, linking to
  • Write to us: [email protected]
  • In a publication, use the following citation: Nüst, Daniel, Simon Jirka, and Ann Hitchcock. Publishing Research Software as Open Source on GitHub. June 2015. url: https://www.gitbook. com/book/52north/pubopen
  • Bibtex entry:
    @Book{2015:52north:pubopen,
Title                    = {Publishing Research Software as Open Source on GitHub},
Author                   = {N\"ust, Daniel and Jirka, Simon and Hitchcock, Ann},
HowPublished             = {online},
Month                    = {jun},
Year                     = {2015},
Url                      = {https://www.gitbook.com/book/52north/pubopen}
}

Correcting and improving content

You found a spelling error? A sentence could be misunderstood and you would like to clarify it?

Great! This best practice is an open source document hosted on GitHub.

  • Before you contribute your changes, please read the used license (see README.md) - by contributing to this book in any way you signal your understanding of the license and its implications.
  • Fork the repository on GitHub.
  • Make your changes to the respective files. Split them into thematically sound git commits with informative commit messages.
  • Create a pull request.

Adding new sections

This section includes advice on how to add new sections to the best practice.

  • Before you contribute your changes, please read the used license (see README.md) - by contributing to this book in any way you signal your understanding of the license and its implications.
  • Open a new issue on GitHub and explain what information is missing in the best practice and why.
  • After discussing with the maintainers of the work, fork the repository on GitHub.
  • Make your changes.
  • Create a pull request.

Translations

Currently, no translations of the book are planned. Do you think this would be useful? Open an issue on GitHub to discuss your ideas with the maintainers.

Documentation

If you have further questions, contact: [email protected]