Skip to content

📝 [REPO]: Added CONTRIBUTING.md with contribution guidelines to the r… #2279

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

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

📝 [REPO]: Added CONTRIBUTING.md with contribution guidelines to the r… #2279

wants to merge 1 commit into from

Conversation

rohitjethoe
Copy link

repo/contributing.md

Added CONTRIBUTING.md with contribution guidelines to the repo.
This can be useful for new github contributors who are finding for open source contribution opportunities.

Fixes #2033


#### For new Contributors

If you never created a pull request before, welcome 🎉 😄 [Here](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github) is a great tutorial on how to send one :)
Copy link
Collaborator

Choose a reason for hiding this comment

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

videos aren't all that accessible, and this particular site/content is used as an enticement to sell access to further videos - can we find different content to link to?

Comment on lines +44 to +51
Good pull requests - patches, improvements, new features - are a fantastic
help. They should remain focused in scope and avoid containing unrelated
commits.

**Please ask first** before embarking on any significant pull request (e.g.
implementing features, refactoring code), otherwise you risk spending a lot of
time working on something that the project's developers might not want to merge
into the project.
Copy link
Collaborator

Choose a reason for hiding this comment

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

This is good advice for projects in general, but in this project, pretty much the only changes that are expected/welcome from non-maintainers are:

  • things with the pull request wanted label
  • updating the eslint config to match the guide
  • editorial improvements to the guide

In particular, it should be noted that no "normative" (ie, things that alter the spirit of how you're recommended to write code) guide or eslint config changes will be made unless it's initiated by current Airbnb employees, so it's not a good use of time to propose any.

@ljharb ljharb marked this pull request as draft April 20, 2021 13:11
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.

Include a Contributing.md to help newcomers to contribute
4 participants