-
Notifications
You must be signed in to change notification settings - Fork 287
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
18 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |