Skip to content

docs: add set of standards - #14

Draft
Mekebrown wants to merge 2 commits into
mainfrom
add-set-of-standards
Draft

Mekebrown wants to merge 2 commits into
mainfrom
add-set-of-standards

Conversation

@Mekebrown

@Mekebrown Mekebrown commented Jun 29, 2023

Copy link
Copy Markdown
Contributor

There are way too many questions to make this into a pull request, so it’s staying as a draft.

Comment thread SET_OF_STANDARDS.md Outdated
# Programming Set of Standards

## Purpose
These are primarily guidelines on contributing ideas and code to the WeLike codebase. As well, there are other helpful insights into what is expected of us as technology industry professionals.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a/WeLike/QueerGlobal/g?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I used a doc from a former project. I look forward to getting lots of eyes on it, to change what it all says since these are all my opinions so far.

Comment thread SET_OF_STANDARDS.md
Comment thread SET_OF_STANDARDS.md
Keywords for A Commits's Subject Matter Message: feat | fix | chore | refactor | docs | style | test | perf | ci | build | revert

When in doubt, refer to this helpful freeCodeCamp post! [How to Level Up Your Git Commit Messages](https://www.freecodecamp.org/news/how-to-write-better-git-commit-messages/)

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Many of the conventions and rules around committing come from this post from Chris Beams, which outlines in detail the desired traits of a commit message. I've worked on teams that have installed pre-commit hooks so that one can't commit a bad message. It's a step to consider over time, I think.

@Mekebrown Mekebrown self-assigned this Jul 3, 2023
@Mekebrown Mekebrown added the documentation Improvements or additions to documentation label Jul 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants