Update CONTRIBUTING.md

[kuddlefishbwaa]

Contributor checklist

• This pull request is on a separate branch and not the main branch

Description

Changing documentation to make easy for ease of access to contributors

Related issue

• Improve contributing guidelines for all scribe-org repos #369

[github-actions]

Thank you for the pull request!

The Scribe team will do our best to address your contribution as soon as we can. The following is a checklist for maintainers to make sure this process goes as well as possible. Feel free to address the points below yourself in further commits if you realize that actions are needed :)

If you're not already a member of our public Matrix community, please consider joining! We'd suggest using Element as your Matrix client, and definitely join the General and iOS rooms once you're in. It'd be great to have you!

Maintainer checklist

• The commit messages for the remote branch should be checked to make sure the contributor's email is set up correctly so that they receive credit for their contribution

  • The contributor's name and icon in remote commits should be the same as what appears in the PR
  • If there's a mismatch, the contributor needs to make sure that the email they use for GitHub matches what they have for git config user.email in their local Scribe-iOS repo

• The CHANGELOG has been updated with a description of the changes for the upcoming release (if necessary)

[andrewtavis]

For this we don't need the .git :)

[andrewtavis]

These here we can leave as <dev-branch> as was done in the [PR we're referencing] :)

[andrewtavis]

We should be good once the changes I mentioned above are fixed, @kuddlefishbwaa. There's gonna be one more minor change in the activist repo, so I'm going to wait till that's finished as maybe we'll want to do that over here as well! Appreciate the help here!

[kuddlefishbwaa]

Removed the things requested, I'll wait for more information on what else needs to be done! :)

[kuddlefishbwaa]

I can start updating with the info from the other pull request as well if you would like. :)

[andrewtavis]

Sure thing, @kuddlefishbwaa! Thanks for keeping on top of all this! 😊

[andrewtavis]

Hey there @kuddlefishbwaa 👋 We're done updating the contributing and readme at activist, so we're good to go as far as making the documentation over here equivalent 😊 Thanks for your patience!

[kuddlefishbwaa]

Great I will start looking through that to start making changes

[andrewtavis]

Thanks, @kuddlefishbwaa! Looking forward to the further changes :)

[andrewtavis]

Another thing that would be great to add in here @kuddlefishbwaa would be to add a reference to commitlint to the contributing guidelines in section 4 of the pull requests section.

[andrewtavis]

I just made a commit to activist that adds the following:

   > [!NOTE]\
   > The following are tools and methods to help you write good commit messages ✨
   >
   > - [commitlint](https://commitlint.io/) helps write [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)
   > - Git's [interactive rebase](https://docs.github.com/en/github/getting-started-with-github/about-git-rebase) cleans up commits

[andrewtavis]

Quick note on this, @kuddlefishbwaa: we can also use add in a quick bit about how the user can use Xcode to clone a repository in the case of iOS. Happy to add it myself, but wanted to send it along so we remember :)

[andrewtavis]

Hey @kuddlefishbwaa 👋 Are you planning any other commits here, or should I review? :)

[kuddlefishbwaa]

I'm going to check over some more with some teammates about Xcode and see if they have thoughts on making it easier to walk through! 😄

[andrewtavis]

Sounds good, @kuddlefishbwaa :) Thank you!

[kuddlefishbwaa]

The team thinks that the Xcode steps are forward enough as is. But I did change some links from the copy over of the starting steps in Contributing. If you have comments or examples of how you would like the Xcode to be outlined if you feel that to be necessary. But otherwise we are good to go!

[andrewtavis]

Thank you, @kuddlefishbwaa! I'll review this in the coming days :)

[andrewtavis]

Sorry that this review took so long, @kuddlefishbwaa :) Has been a very busy month and a bit for me. Appreciate the work here! I'll go through and make any needed changes and close out the issue 🚀