forked from swent-epfl/prd
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Simplify and clarify the instructions
- Loading branch information
Showing
1 changed file
with
15 additions
and
26 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 |
---|---|---|
@@ -1,41 +1,30 @@ | ||
## Description | ||
### Description | ||
|
||
This repository contains an outline template for the PRD. | ||
It also contains a sample PRD under `samples/epfl-pocketcampus` for your reference. | ||
This repository contains a template for the PRD deliverable for the CS-311: The Software Enterprise (SwEnt) course. | ||
You can find it in the `template` folder. | ||
|
||
>[!NOTE] | ||
>As you may know, the EPFL Pocketcampus app was developed in the first iteration | ||
>of this course. | ||
There is also a sample PRD under `samples/epfl-pocketcampus`; this is for the EPFL Pocketcampus app, which was developed during the very first intantiation of this course. You can use this sample PRD as a reference. | ||
|
||
The folder `template` contains the outline for the PRD to get you started. | ||
|
||
>[!IMPORTANT] | ||
> When you begin filling out the various sections, you should remove the | ||
> comments added in italics. They are only there to help start your thinking | ||
> process. | ||
## Setup | ||
### Instructions | ||
|
||
1. Fork this repo into your organization and clone it | ||
``` | ||
git clone git@github.com:<your-org-name>/prd.git | ||
cd prd | ||
``` | ||
|
||
2. Setup Github Actions - | ||
|
||
To help you with generating the PDF of your PRD, this repo contains a workflow called `build_pdf.yml`. | ||
|
||
To configure the workflow, please change the following lines - | ||
2. Set up Github Actions | ||
|
||
* Team Number | ||
This repo includes a workflow called `build_pdf.yml` that uses GitHub Actions to automatically generate a PDF of your PRD. | ||
|
||
Change the `<Team Number>` to your team's number (e.g., 26) [here](.github/workflows/build_pdf.yml#40). | ||
|
||
* Artifact Name | ||
|
||
Change the `<number>` in the PDF name for the Artifact [here](.github/workflows/build_pdf.yml#46). | ||
After cloning this repo, customize the workflow for your own team by editing the workflow as follows: | ||
|
||
- Line 40: Set the right team number, by replacing `26` with your team's number [here](.github/workflows/build_pdf.yml#40); | ||
- Line 46: Same for the PDF artifact's name (replace `26` with your team's number) [here](.github/workflows/build_pdf.yml#46). | ||
|
||
3. Write your PRD | ||
|
||
You can add content to your PRD and push to `main` to generate the PDF. Or you can follow a collaborative workflow of working in branches and making PRs. We trust you can self-organize as a team to achieve this. | ||
To produce your own PRD, read the comments in italics, fill out the various sections, then remove the comments. | ||
Use a collaborative workflow (branches, PRs, etc.) within your team to edit the PRD. | ||
Pushing to `main` will generate the PDF. | ||
|