Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create CONTRIBUTING.md #3115

Merged
merged 2 commits into from
Aug 28, 2023
Merged

Create CONTRIBUTING.md #3115

merged 2 commits into from
Aug 28, 2023

Conversation

clairecharles
Copy link
Contributor

Please review the following checklist.

Fixes #2933

  • Docstrings on all new or modified functions / classes
  • Updated documentation
  • Updated CHANGELOG.md (where appropriate)

Copy link
Contributor

@rodrigogiraoserrao rodrigogiraoserrao left a comment

Choose a reason for hiding this comment

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

Hey Claire, thanks for your PR.

While I think you nailed the welcoming tone for the document, I think the content is not what we are going for.
I think we can drop most of the generic advice, for example the style guide for commit messages or how to create a pull request.
Instead, what we can do is link to proper guides/documentation when needed.

A great alternative, that applies to pretty much everything else, is that we can point to examples of things we've done and that contributors can copy/mimic.

So, instead of focusing on these generic things that are more or less the same for every open source project, the focus of our contributing document should be on the textual-specific workflows.
For example,

  • how does one setup the development environment for textual?
  • what's the textual-specific checklist that we need to go through before opening a PR?
  • how does one create a snapshot test?

Some of these things have already been answered in #2923, which was linked from the issue #2933 that you are fixing.

So, please take your time to go through #2923 and we're looking forward to your revised PR.
Thanks!

Copy link
Collaborator

@willmcgugan willmcgugan left a comment

Choose a reason for hiding this comment

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

Great work. Thanks!

@willmcgugan willmcgugan merged commit 409363d into Textualize:main Aug 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add CONTRIBUTING.md
3 participants