docs: add contribution guidelines #181

chrisvxd · 2023-10-20T11:44:09Z

No description provided.

vercel · 2023-10-20T11:44:13Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
puck-demo	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 20, 2023 3:23pm

monospaced

Made a bunch of comments, but nothing that I feel requires amendment. Happy for this to be merged as-is, but leaving my notes here in case they are helpful.

monospaced · 2023-10-20T12:41:15Z

CONTRIBUTING.md

+- Open a discussion via GitHub
+- Use the #chat or #help channels in our [Discord server](https://discord.gg/D9e4E3MQVZ)
+
+**GitHub issues are for bugs and feature requests, not for questions.**


Not sure bolding is needed here, comes across a little <strong> 🥁. Maybe italics?

monospaced · 2023-10-20T12:45:51Z

CONTRIBUTING.md

@@ -0,0 +1,120 @@
+# Contribution guidelines


I think "Contributing guide" is a more common title form for CONTRIBUTING.md maybe?

Could include the name, "Puck contributing guide" or similar.

Example:

https://github.com/github/docs/blob/f3b2edcd8076e10b69239a492bc483b89d531455/CONTRIBUTING.md

Or just "Contributing to Puck"

monospaced · 2023-10-20T12:46:37Z

CONTRIBUTING.md

+
+We manage our backlog using labels. Labels can help you understand the status of each ticket.
+
+### Status labels


Wonder if we should add a good first issue label and mention it here?

Did think that but we don't have the label yet... will check the backlog and make one if I think there are any issues

monospaced · 2023-10-20T12:49:30Z

CONTRIBUTING.md

+
+## Reporting bugs or requesting features
+
+Bugs and feature requests are best reported via GitHub issues. If you're unsure whether or not you've encounter a bug, feel free to ask first.


Could include some "please search first before creating a new issue" words here, but I don't think we're currently getting a lot of dupes. Could leave for now, and add if (when) it becomes a problem.

CONTRIBUTING.md

monospaced · 2023-10-20T12:56:11Z

CONTRIBUTING.md

+
+- **ready** - this ticket has a description and is ready to be worked on.
+- **in triage** - this ticket has been seen by the Puck team and we are identifying next steps. Tickets may stay in this state until we're ready to process them.
+- **opinions wanted** - we're looking for opinions on this ticket. Feel free to chime in with comments or suggestions.


Assume that opinions wanted would

only (mostly) be used on feature requests, and

not be used with the in triage label, as it's now been processed and maintainer's view is we need to gather community input before we can proceed. Then once the opinions have been gathered, it moves to ready (or gets closed)? Asking cause it seems like there is some crossover with this label and the guidance above to not ask questions in issues.

And in general, would only one of these labels be present on a issue at a time (i.e. radio buttons not checkbox group)?

I think mostly. Bug fixes might also require some opinions. Also sometimes it's softer, like "how do you want to engage with puck".

Probably not, but I don't think it needs to be that strict.

I've split these out into an "Other labels" section, alongside "Good first issue"

anglepoised · 2023-10-20T15:17:06Z

CONTRIBUTING.md

@@ -0,0 +1,120 @@
+# Contribution guidelines


Or just "Contributing to Puck"

anglepoised · 2023-10-20T15:17:59Z

CONTRIBUTING.md

+
+## Reporting bugs or requesting features
+
+Bugs and feature requests are best reported via GitHub issues. If you're unsure whether or not you've encounter a bug, feel free to ask first.


Suggested change

Bugs and feature requests are best reported via GitHub issues. If you're unsure whether or not you've encounter a bug, feel free to ask first.

Bugs and feature requests are best reported via GitHub issues. If you're unsure whether or not you've encountered a bug, feel free to ask first.

anglepoised · 2023-10-20T15:19:44Z

CONTRIBUTING.md

+
+Bugs and feature requests are best reported via GitHub issues. Always check if the issue already exists before opening a new one.
+
+If you're unsure whether or not you've encounter a bug, feel free to ask first 👇


Suggested change

If you're unsure whether or not you've encounter a bug, feel free to ask first 👇

If you're unsure whether or not you've encountered a bug, feel free to ask first 👇

anglepoised · 2023-10-20T15:20:39Z

CONTRIBUTING.md

+There are several ways to ask questions or ask for help:
+
+- Open a [discussion](https://github.com/measuredco/puck/discussions) via GitHub
+- Use the #chat or #help channels in our [Discord server](https://discord.gg/D9e4E3MQVZ)


Maybe less friction for people to point to just one Discord channel?

Suggested change

- Use the #chat or #help channels in our [Discord server](https://discord.gg/D9e4E3MQVZ)

- Use the #help channel in our [Discord server](https://discord.gg/D9e4E3MQVZ)

anglepoised · 2023-10-20T15:21:40Z

CONTRIBUTING.md

+- Open a [discussion](https://github.com/measuredco/puck/discussions) via GitHub
+- Use the #chat or #help channels in our [Discord server](https://discord.gg/D9e4E3MQVZ)
+
+_GitHub issues are for bugs and feature requests, not for questions._


Friendly reword.

Suggested change

_GitHub issues are for bugs and feature requests, not for questions._

_Please only use GitHub issues for bugs and feature requests, and not for questions._

anglepoised · 2023-10-20T15:23:10Z

CONTRIBUTING.md

+
+### Other labels
+
+- **good first issue** - if you're new to contributing on Puck, this is a good palce to start.


Suggested change

- **good first issue** - if you're new to contributing on Puck, this is a good palce to start.

- **good first issue** - if you're new to contributing on Puck, this is a good place to start.

anglepoised · 2023-10-20T15:25:16Z

CONTRIBUTING.md

+
+**Keep your PRs focused to a single issue**. This makes it easier to review and is necessary for our release process.
+
+We rely on angular-style conventional commits for automating our releases, determining the version bump and generating our changelog.


Worth linking to a guide to Angular-style, or just Conventional Commits docs here?

anglepoised · 2023-10-20T15:25:41Z

CONTRIBUTING.md

+
+You generally don't need to write perfect commit messages yourselves - we squash most PRs and rewrite the messages on merge.
+
+If you need to solve multiple issues, it's best to split it into multiple PRs. Or, if you're comfortable writing convential commits, you can also split each change into a separate commit. The team is more likely to have opinions about this and you may be asked to reword your commits.


Suggested change

If you need to solve multiple issues, it's best to split it into multiple PRs. Or, if you're comfortable writing convential commits, you can also split each change into a separate commit. The team is more likely to have opinions about this and you may be asked to reword your commits.

If you need to solve multiple issues, it's best to split it into multiple PRs. Or, if you're comfortable writing conventional commits, you can also split each change into a separate commit. The team is more likely to have opinions about this and you may be asked to reword your commits.

anglepoised · 2023-10-20T15:27:57Z

CONTRIBUTING.md

+
+- TypeScript
+- CSS Modules
+- Turbo repo for efficient monorepo scripting


Suggested change

- Turbo repo for efficient monorepo scripting

- Turborepo for efficient monorepo scripting

anglepoised · 2023-10-20T15:28:22Z

CONTRIBUTING.md

+
+#### CSS
+
+- Class names must follow [SUIT CSS](https://suitcss.github.io) convention. This is a tooling-angostic convention used at [@measuredco](https://github.com/measuredco) for all CSS work.


Suggested change

- Class names must follow [SUIT CSS](https://suitcss.github.io) convention. This is a tooling-angostic convention used at [@measuredco](https://github.com/measuredco) for all CSS work.

- Class names must follow [SUIT CSS](https://suitcss.github.io) convention. This is a tooling-agnostic convention used at [@measuredco](https://github.com/measuredco) for all CSS work.

chrisvxd requested review from anglepoised and monospaced October 20, 2023 11:44

vercel bot deployed to Preview October 20, 2023 11:45 View deployment

monospaced approved these changes Oct 20, 2023

View reviewed changes

chrisvxd force-pushed the contribution-guidelines branch from f83f440 to 702a6f3 Compare October 20, 2023 15:18

vercel bot deployed to Preview October 20, 2023 15:19 View deployment

docs: add contribution guidelines

28d9ad6

chrisvxd force-pushed the contribution-guidelines branch from 702a6f3 to 28d9ad6 Compare October 20, 2023 15:22

vercel bot deployed to Preview October 20, 2023 15:23 View deployment

chrisvxd merged commit 17fc4dc into main Oct 20, 2023
2 checks passed

chrisvxd deleted the contribution-guidelines branch October 20, 2023 15:23

anglepoised requested changes Oct 20, 2023

View reviewed changes

chrisvxd mentioned this pull request Oct 20, 2023

Fix links in Code of Conduct and address further CONTRIBUTING comments #182

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: add contribution guidelines #181

docs: add contribution guidelines #181

chrisvxd commented Oct 20, 2023

vercel bot commented Oct 20, 2023 •

edited

Loading

monospaced left a comment

monospaced Oct 20, 2023

chrisvxd Oct 20, 2023

monospaced Oct 20, 2023

anglepoised Oct 20, 2023

chrisvxd Oct 20, 2023

monospaced Oct 20, 2023

chrisvxd Oct 20, 2023

chrisvxd Oct 20, 2023

monospaced Oct 20, 2023

chrisvxd Oct 20, 2023

monospaced Oct 20, 2023

chrisvxd Oct 20, 2023

chrisvxd Oct 20, 2023

anglepoised Oct 20, 2023

anglepoised Oct 20, 2023

anglepoised Oct 20, 2023

anglepoised Oct 20, 2023

anglepoised Oct 20, 2023

anglepoised Oct 20, 2023

anglepoised Oct 20, 2023

anglepoised Oct 20, 2023

anglepoised Oct 20, 2023

anglepoised Oct 20, 2023


		We manage our backlog using labels. Labels can help you understand the status of each ticket.

		### Status labels


		## Reporting bugs or requesting features

		Bugs and feature requests are best reported via GitHub issues. If you're unsure whether or not you've encounter a bug, feel free to ask first.


		Bugs and feature requests are best reported via GitHub issues. Always check if the issue already exists before opening a new one.

		If you're unsure whether or not you've encounter a bug, feel free to ask first 👇

	- Use the #chat or #help channels in our [Discord server](https://discord.gg/D9e4E3MQVZ)
	- Use the #help channel in our [Discord server](https://discord.gg/D9e4E3MQVZ)

	_GitHub issues are for bugs and feature requests, not for questions._
	_Please only use GitHub issues for bugs and feature requests, and not for questions._


		### Other labels

		- good first issue - if you're new to contributing on Puck, this is a good palce to start.


		Keep your PRs focused to a single issue. This makes it easier to review and is necessary for our release process.

		We rely on angular-style conventional commits for automating our releases, determining the version bump and generating our changelog.


		You generally don't need to write perfect commit messages yourselves - we squash most PRs and rewrite the messages on merge.

		If you need to solve multiple issues, it's best to split it into multiple PRs. Or, if you're comfortable writing convential commits, you can also split each change into a separate commit. The team is more likely to have opinions about this and you may be asked to reword your commits.

	- Turbo repo for efficient monorepo scripting
	- Turborepo for efficient monorepo scripting


		#### CSS

		- Class names must follow [SUIT CSS](https://suitcss.github.io) convention. This is a tooling-angostic convention used at [@measuredco](https://github.com/measuredco) for all CSS work.

docs: add contribution guidelines #181

docs: add contribution guidelines #181

Conversation

chrisvxd commented Oct 20, 2023

vercel bot commented Oct 20, 2023 • edited Loading

monospaced left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vercel bot commented Oct 20, 2023 •

edited

Loading