Contributing Guidelines

https://csci-1301.github.io/about#authors

October 23, 2021 (06:09:50 PM)

How can I contribute?

If you are a student

We would like to hear your thoughts on this resource to understand how to make it better for you and your fellow students. If you encounter a mistake, run into an issue while using the resource, or find it missing something important, you can contribute by providing feedback in one of the following ways:

  • talk to your instructor about the issue
  • talk to your section’s UCA about the issue
  • leave feedback on this website on the page where you notice the issue
  • Open an issue
  • print the resource and identify the issue, then hand it to your instructor or UCA

If you have suggestions on how to make it better, we encourage you to share those ideas too.

If you are an instructor

You will need to have a Github account. Next contact any of the authors of this resource over email, provide your Github username, and request an invitation to be added to the instructors team.

If you are a UCA

You will need to have a Github account. Next ask your course section instructor to invite you to the 1301 UCAs team. Your instructor needs your Github username to send you the invitation.

If you are an outside collaborator

When you have identified a mistake in this resource and want to notify the authors, leave feedback on this website on the page where you notice the issue or open an issue explaining the issue.

If you want to make edits yourself, you can fork the source code, make edits, then open a pull request for us to review.

Next steps for editors

If you are looking to edit this resource and making your first contribution, read through the user guide. It explains:

Following the user guide will help to ensure your edits meet the expected quality guidelines and can be integrated into the existing resource with ease.