Merge pull request #4297 from JacquesCarette/coAuthorshipWiki

Wiki: Explain how to acknowledge co-authors.

Author: JacquesCarette

wiki/Contributor's-Guide.md

@@ -103,6 +103,7 @@ To maintain a clean, understandable project history and improve collaboration, p
       2. Update
       3. more edits
   - Of course, these messages should line up with what was actually changed
+- *Acknowledge your co-authors!* Each commit declares who submitted the work. For example, [130e76](https://github.com/JacquesCarette/Drasil/commit/130e76ed4246989765cf1b7440ccadb7f226df2b.patch) shows that Jason wrote the commit (see the “From” field). Normally, we assume that Jason wrote this code himself as well. For situations where this isn't true, such as in [8deb7c](https://github.com/JacquesCarette/Drasil/commit/8deb7caf8442b90a1fa56f1926e2d44a378230a4.patch), we should note each contributor by appending a new line in the format "Co-Authored-By: X <X's email>" to the end of the commit message. If multiple authors exist, you should append one new line in that format for each contributor.
 - Properly syncing with `main`
   - Syncing with `main` regularly can be a very good thing due to the existance of stable artifacts checked into the repo, when done correctly
     1. Avoid using `merge`, it results in many merge commits making the commit history very "noisy"
@@ -154,4 +155,4 @@ The internet is your friend. Back on the topic of seeking help, you will also fi
 
 <!-- Add any more advice here and remove this comment when done -->
 
-Sincerely, the students of Summer 2021.
+Sincerely, the students of Summer 2021.

wiki/Git2Know-for-Drasil.md

@@ -56,10 +56,11 @@ Making a commit to a repository
     ```
     git status
     ```
-2. Creating a commit. This step will actually apply your changes to your local repository. Use the following function to commit your changes (after they have been staged):
+2. Creating a commit. This step will actually apply your changes to your local repository. Use the following function to commit your changes (after they have been staged) with short-form messages:
     ```bash
     git commit -m "meaningful message to communicate changes made"
     ```
+    If you'd like to write a more comprehensive, long-form commit message, running only `git commit` will open a text editor (`nano` by default) you can use. This is particularly helpful for when there are [co-contributors you need](#co-authorship) to acknowledge.
 3. Pushing commits to a remote repository. This will create or update an identical branch to the repository you initially `cloned` from. For others to see the changes you made, push them to remote repository by using:
     ```
     git push
@@ -70,6 +71,9 @@ Making a commit to a repository
     ```
 4. Pulling from the remote repository. When others make changes, `git pull` syncs your local version with any changes made to the remote repository. 
 
+### Co-Authorship
+
+Working with others, you should always acknowledge so. Commits declare who *submitted* work (e.g., [130e76](https://github.com/JacquesCarette/Drasil/commit/130e76ed4246989765cf1b7440ccadb7f226df2b.patch) shows that Jason wrote the commit). Normally, we assume that Jason wrote this code himself as well. GitHub will similarly assume this and attribute this work to Jason through the [Contributor's Statistics](https://github.com/JacquesCarette/Drasil/graphs/contributors) page. In situations where others helped you work on a commit, you should always acknowledge them somehow. Conventionally, with git, we append a new line in the format "Co-Authored-By: X <X's email>" to the end of the commit message. If multiple authors exist, we append one new line for each contributor. For example, [8deb7c](https://github.com/JacquesCarette/Drasil/commit/8deb7caf8442b90a1fa56f1926e2d44a378230a4.patch) shows all contributors, who, as of Mon, 3 Jun 2024 contributed to the wiki.
 
 ## Oops, how do I undo a commit?!? 
 One of the following commands may help if you find you made some changes to a commit that you want to revert.
@@ -81,7 +85,6 @@ One of the following commands may help if you find you made some changes to a co
  ### I pushed it to the remote repo! 
 - `git revert <#commitHash>` (creates inverse commit to commit #commitHash)  
 
-
 ## Pull Requests 
 This is a common process for fetching the latest data from the remote repository, making some changes, and then contributing back to the remote repository. A pull request is a method for telling the owners/maintainers of a remote repo that you wish to add your changes.
 1. Make sure your main branch is up to date by switching to it (using `git switch main`) and using `git pull` 
@@ -202,4 +205,4 @@ Follow these steps:
 ## Avoidable Issues 
 I’ve made changes to the code, but the program says there’s nothing to commit? 
 - might seem obvious but don’t forget to save your changes! `CTRL+S`
-- or, if you are trying to change the capitalization of a file, see this [Stack Overflow page](https://stackoverflow.com/questions/10523849/changing-capitalization-of-filenames-in-git)
+- or, if you are trying to change the capitalization of a file, see this [Stack Overflow page](https://stackoverflow.com/questions/10523849/changing-capitalization-of-filenames-in-git)