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

Update contributing docs to save people's time #273

Merged
merged 1 commit into from
Nov 13, 2023

Conversation

ahmed-hritani
Copy link
Contributor

Result of #269.

Save people's time by defining the contributing constraints.

@iambumblehead iambumblehead merged commit 9afa807 into iambumblehead:main Nov 13, 2023
10 checks passed
@iambumblehead
Copy link
Owner

It is good to expect some discussion when submitting changes to the README of a project.

@ahmed-hritani
Copy link
Contributor Author

It is good to expect some discussion when submitting changes to the README of a project.

That's for sure, thing is that it's usually the case that such things are in the CONTRIBUTING.md file and such discussion happen before the PR is merged.

Thanks for the effort.

@iambumblehead
Copy link
Owner

That's true and also we're human and make mistakes.

@iambumblehead
Copy link
Owner

Two things that would reduce friction for README PRs imo,

  1. README examples should also exist in live unit-tests verified by the testing job. This would enforce passing README tests and also increase the size of those PRs, increasing expectation of discussion,
  2. The README linting should be fixed, so that the README is linted as part of the CI pipeline for each PR

@iambumblehead
Copy link
Owner

related eslint/markdown#227

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.

3 participants