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

239 Contributing docs #242

Merged
merged 4 commits into from
Apr 20, 2023
Merged

239 Contributing docs #242

merged 4 commits into from
Apr 20, 2023

Conversation

Sephsekla
Copy link
Collaborator

@Sephsekla Sephsekla commented Apr 5, 2023

What?

Add a CONTRIBUTING.md file with instructions for contributors.

Why?

Resolves #239

How?

Testing Instructions

Screenshots or screencast

@Sephsekla Sephsekla added the documentation Improvements or additions to documentation label Apr 5, 2023
@Sephsekla Sephsekla added this to the 0.2.0 milestone Apr 5, 2023
@Sephsekla Sephsekla self-assigned this Apr 5, 2023
@Sephsekla Sephsekla linked an issue Apr 5, 2023 that may be closed by this pull request
@erikyo erikyo marked this pull request as ready for review April 5, 2023 16:32
@johnhooks
Copy link
Collaborator

johnhooks commented Apr 5, 2023

I think the initial, "how do you get connected" section is still very effective.

It would be helpful to define a roadmap and explain where the current focus is. This probability doesn't belong in the CONTRIBUTING.md, but linking to where to find that information could direct new contributors towards the areas we need help (possibly linking to a project board). The issues list, by its nature, is rather unorganized and hard to look at as a newcomer and make any sense of the priorities.

List the current maintainers and who has the authority to merge pull requests.

What are the criteria for accepting pull requests:

  • bugs: merged as quickly as possible
  • refactors: merged if deemed necessary by the maintainers
  • features: first considered whether or not it fits the project, if determined to fit with the projects goals, it’s placed into the project board, into the system and when complete is merged when it fits with the release schedule.

I'm pretty new to this, so those are just ideas. It can be hard to tell sometimes in projects like this whether or not contributions are welcomed. Providing a "when contributing" section that lays out how someone should approach offering a new idea can give them confidence we want their input and have thought through the process.

@Sephsekla Sephsekla requested a review from johnhooks April 20, 2023 16:06
@Sephsekla
Copy link
Collaborator Author

@johnhooks there's still a lot that could be added here, but for now I'd like to get something merged and then we can get 0.2.0 out. What do you think?

Copy link
Collaborator

@johnhooks johnhooks left a comment

Choose a reason for hiding this comment

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

This looks great @Sephsekla, I think you did a great job explaining the process of the PR workflow. Only suggestion, could you add the CONTRIBUTING.md to the .distignore file?

@@ -2,53 +2,18 @@

> A feature plugin for WordPress, which aims to create a new (better) way to manage and deliver notifications to the relevant audience.

- Contributors: schlessera, psykro, raaaahman, danbilauca, sephsekla
- Contributors: schlessera, psykro, raaaahman, danbilauca, Sephsekla, erikyo, JasonTheAdams, johnhooks
Copy link
Collaborator

Choose a reason for hiding this comment

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

❤️ thanks!

@Sephsekla Sephsekla requested a review from johnhooks April 20, 2023 16:24
@Sephsekla
Copy link
Collaborator Author

I don't think it actually makes a difference to the release process now we're using wp-scripts, but it's at the very least complete.

Copy link
Collaborator

@johnhooks johnhooks left a comment

Choose a reason for hiding this comment

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

LGTM!

@johnhooks
Copy link
Collaborator

I don't think it actually makes a difference to the release process now we're using wp-scripts, but it's at the very least complete.

@Sephsekla the only reason I thought to add it is because we have that file and might use it someday, we should either keep it up to date or remove it.

@Sephsekla Sephsekla merged commit df5336b into develop Apr 20, 2023
@Sephsekla Sephsekla deleted the 239-contributing-doc branch April 20, 2023 16:28
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.

Create a CONTRIBUTING.md doc
2 participants