search

awegroup / AWE-Eco

A reference economic model for airborne wind energy systems
MIT License
2 stars 0 forks source link

Guideline for collaborative workflow #15

Closed rishikeshsjoshi closed 2 weeks ago

rishikeshsjoshi commented 1 month ago

To accept contributions from external contributors in future as we want to keep the code live. This code is attached to a published version of a report. How to log the key improvements in the code against the published version of the report?

mwakok commented 1 month ago

You can address this with two documents:

  1. A Contributing guide that documents how external contributors can contribute. I often this example as my starting point: https://github.com/matchms/matchms/blob/master/CONTRIBUTING.md
  2. A Changelog where you document the changes of each release of your software. See the same repository for an example: https://github.com/matchms/matchms/blob/master/CHANGELOG.md.
    • A changelog will make most sense if you follow a release workflow. This will also allow you to be able to quickly find the published version of the software.

You will need to decide yourself how you would like external developers to contribute and how you will maintain and support the software in the future.