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 file #17

Open
joshmedeski opened this issue Aug 16, 2023 · 0 comments
Open

Create CONTRIBUTING.md file #17

joshmedeski opened this issue Aug 16, 2023 · 0 comments

Comments

@joshmedeski
Copy link
Owner

As a maintainer of an open-source project, I want a clear and helpful CONTRIBUTING.md document that explains how to contribute to the project, so that I can set expectations and explain how I'd like new code the be added to the project.

  • Explain the values of the project
  • Explain how to add a new icon (alphabetically)
  • Explain the single responsibility principle (one change at a time, please)
  • Explain that git commits don't really matter (we squash merge)
  • Explain that new features should be discussed and agreed upon before a pull request will be accepted
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

No branches or pull requests

1 participant