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

Bring back "Guidelines for Contributing" #3644

Merged
merged 6 commits into from
Sep 16, 2022
Merged

Conversation

ksuess
Copy link
Member

@ksuess ksuess commented Sep 16, 2022

@netlify
Copy link

netlify bot commented Sep 16, 2022

Deploy Preview for volto ready!

Name Link
🔨 Latest commit
🔍 Latest deploy log https://app.netlify.com/sites/volto/deploys/63249a66e68e5866a3be5541
😎 Deploy Preview https://deploy-preview-3644--volto.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@cypress
Copy link

cypress bot commented Sep 16, 2022



Test summary

348 0 15 0


Run details

Project Volto
Status Passed
Commit 873dc2a
Started Sep 16, 2022 2:55 PM
Ended Sep 16, 2022 3:06 PM
Duration 10:27 💡
OS Linux Ubuntu - 20.04
Browser Chrome 105

View run in Cypress Dashboard ➡️


This comment has been generated by cypress-bot as a result of this project's GitHub integration settings. You can manage this integration in this project's settings in the Cypress Dashboard

@stevepiercy
Copy link
Collaborator

Thanks for taking this on, @ksuess!

For the record, the original file contributing/index.md was an earlier version of, and therefore redundant to, developer-guidelines/design-principles.md. This restoration moves the content of the original contributing/guidelines.md into developer-guidelines/contributing.md, with some clean up.

Review coming shortly.

@stevepiercy
Copy link
Collaborator

We now have a Plone GitHub organization CONTRIBUTING.md. When a repo, including Volto, lacks a CONTRIBUTING.md file in its repo, then this will be displayed. Clearly this is not what we want.

I would suggest that we add a CONTRIBUTING.md file at the root of this repo, that contains only the following:

# Contributing to Volto

See [Contributing to Volto](https://6.dev-docs.plone.org/volto/developer-guidelines/contributing.html).

More information about GitHub Community Health Files, specifically About contributing guidelines.

Copy link
Collaborator

@stevepiercy stevepiercy left a comment

Choose a reason for hiding this comment

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

Lots of obsolete stuff needed changing.

Feedback appreciated.

docs/source/developer-guidelines/contributing.md Outdated Show resolved Hide resolved
docs/source/developer-guidelines/contributing.md Outdated Show resolved Hide resolved
docs/source/developer-guidelines/contributing.md Outdated Show resolved Hide resolved
docs/source/developer-guidelines/contributing.md Outdated Show resolved Hide resolved
docs/source/developer-guidelines/contributing.md Outdated Show resolved Hide resolved
docs/source/developer-guidelines/contributing.md Outdated Show resolved Hide resolved
docs/source/developer-guidelines/contributing.md Outdated Show resolved Hide resolved
docs/source/developer-guidelines/contributing.md Outdated Show resolved Hide resolved
docs/source/developer-guidelines/contributing.md Outdated Show resolved Hide resolved

All text that can be shown in a browser must be translatable. Please mark all such
strings as translatable as defined in the [i18n guide](../recipes/i18n.md)

Copy link
Collaborator

Choose a reason for hiding this comment

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

Replace everything below this comment with the following.

## Code Quality

All pull requests must pass tests, documentation builds, and other code quality checks.
Contributors are strongly encouraged to run these checks locally before creating a pull request.
These checks are enforced automatically on every pull request, so you might as well save time and frustration by doing these checks locally first.

Specifically:

-   {doc}`./linting`
-   {doc}`./testing`
-   {doc}`./acceptance-tests`

If after reading this you become hesitant, don't worry.
You can always create a pull request, mark it as "Draft", and improve the above points later, requesting help from the community.

Welcome to the Plone community, and thank you for contributing!

Copy link
Collaborator

@stevepiercy stevepiercy left a comment

Choose a reason for hiding this comment

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

Thank you! LGTM!

@stevepiercy stevepiercy merged commit 406da71 into master Sep 16, 2022
@stevepiercy stevepiercy deleted the bring-back-contributing branch September 16, 2022 20:23
@sneridagh
Copy link
Member

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

Successfully merging this pull request may close these issues.

3 participants