Closed burgess01 closed 2 years ago
Hello @burgess01, thanks for raising this issue!
Your team should define a process that all other teams need to follow in order to merge content into the main branch of the course web site. The entire process needs to be documented in a file in this GitHub repository. If you would like, the process for updating the web site can be featured on the web site itself! Please note that we are using Netlify for the builds of this web site. You should review how Netlify creates preview builds so that you can understand and configure this process!
The members of your team are also responsible for reviewing all of the PRs that the other team members create. You will need to ensure that all of the writing is technically correct and does not contain any formatting or spelling mistakes. You will also need to work with the different teams to ensure that the class approves of the content that they are creating. For instance, please don't merge an update to the course schedule if there are members of the class that don't agree with the schedule.
In addition to carefully reviewing all of the content that we create, it is important for you to merge PRs in a timely fashion. Remember, we need to have a working version of the web site ready for our classroom session on Tuesday of next week!
Once the semester starts you will not have to review all of the PRs that I create to add new content (e.g., course slides) to the web site. However, I will still try to follow the approach that you outline for creating, naming, and merging PRs. As students continue to add content to the web site (e.g., each week there will be two experts who are responsible for drawing a diagram that explains that module's contents) it would be great if you can continue to help me to review and merge PRs.
I also encourage you to think carefully about the structure of the commit messages that contributors write. As you will see, I have adopted the Conventional Commits standard for writing commit messages. You can learn more about it at this web site: https://www.conventionalcommits.org/en/v1.0.0/
We were thinking that we could have PRs be approved by one person on integration and one person on that team in order to make sure that no errors are merged in. Before the integration person approves we will send it in to the rest of the class, asking for any changes. If none are sent in, we will merge the branch. We also thought that PRs should follow the format covered in 203, i.e. first letter capitalized, no periods, first word in imperative tense, no more than 50 characters, meaningful and concise. Do you think this is a good idea?
Hello @burgess01, are there any remaining tasks associated with this issue?
If there are, then please list them here. If you think that everything is finished, then please close this issue. Thanks!
We are in charge of integrating the work of the other groups on to the website and making sure that nothing that we add breaks. Lead: Katie Associate: Caden