Skip to content

Commit

Permalink
Merge pull request #754 from dirac-institute/mschwamb-patch-1
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
mschwamb authored Dec 15, 2023
2 parents 8b30f9d + 71db81e commit 084172a
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@ Documentation: https://sorcha.readthedocs.io

Other software utilities can be found in this github repository: [https://github.com/dirac-institute/sorcha-addons](https://github.com/dirac-institute/sorcha-addons)
## developer best practices
* Data sets should be moved to the `data` folder, have a readme.txt or readme.md to explain where the data came from as well as a time stamp in the readme.txt.
* Data sets should be moved to the `src/sorcha/modules/data` folder, have a readme.txt or readme.md to explain where the data came from as well as a time stamp in the readme.txt.
* Data sets that are used for unit testing should live in `tests/data`.
* All required input files for the main software or unit tests should have extensions that clearly describe the file format (e.g. .csv, .txt, .db, .fits)
* If you are working on addressing a specific issue ticket, assign yourself the ticket and set the status to "in progress"
* If you are working on addressing a specific issue ticket, assign yourself the ticket.
* When making a pull request that closes an issue, cite the issue ticket in the pull request summary

## Collaboration
Expand Down

0 comments on commit 084172a

Please sign in to comment.