diff --git a/PW40_2024_GranCanaria/Projects/README.md b/PW40_2024_GranCanaria/Projects/README.md new file mode 100644 index 000000000..01000789c --- /dev/null +++ b/PW40_2024_GranCanaria/Projects/README.md @@ -0,0 +1,18 @@ +# How to create a new project + +- Post questions about the project idea and team on the [Project Week forum][forum], our communication mechanism as of PW28. +- When you are ready, add a new entry in the list of **Projects** by creating a new `README.md` file in subfolder in `Projects` folder, and copying contents of [project description template][project-description-template] file into it. Step-by-step instructions for this are: + +1. Open [project description template][project-description-template] and copy its full content to the clipboard + * If the link does not work (https issues) please try [here](https://github.com/NA-MIC/ProjectWeek/blob/master/PW40_2024_GranCanaria/Projects/Template/README.md) +3. Go back to [Projects](https://github.com/NA-MIC/ProjectWeek/tree/master/PW40_2024_GranCanaria/Projects) folder on GitHub +4. Click on "Create new file" button +5. Type `YourProjectName/README.md` + - When naming the file, **please ensure there are no spaces/special characters in the folder or file name** +6. Paste the previously copied content of project template page into your new `README.md` +7. Update at least your project's __title, category, key investigators, location, and project description sections__ +8. Create a [pull request](https://help.github.com/articles/creating-a-pull-request/) with the new page + + +[forum]: https://discourse.slicer.org/c/community/project-week +[project-description-template]: https://raw.githubusercontent.com/NA-MIC/ProjectWeek/master/PW40_2024_GranCanaria/Projects/Template/README.md