-
Notifications
You must be signed in to change notification settings - Fork 19
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
Conversation
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:
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. |
@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? |
There was a problem hiding this 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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
❤️ thanks!
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
@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. |
What?
Add a
CONTRIBUTING.md
file with instructions for contributors.Why?
Resolves #239
How?
Testing Instructions
Screenshots or screencast