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.

Sign up for GitHub

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

Jump to bottom

Add important information to the README #67

Open
mcortes19 opened this issue Nov 11, 2022 · 0 comments
Open

Add important information to the README #67

mcortes19 opened this issue Nov 11, 2022 · 0 comments
Labels
📖 Needs Documentation 🪄 Enhancement New feature or request. 👉 Good First Issue A good issue or PR to start with.

Comments

@mcortes19
Copy link
Collaborator

Expected Behavior

As a new contributor I need to have all the information related to established code conventions (variable naming, comment structure, etc) by doing this, reviewers can focus on the functionality instead of requesting changes related to the look of the code

Current Behavior

As a new contributor there's a big chance to get my PR rejected due to don't know code conventions for the project

Possible Solution

Add to the README file the "established code conventions"
@amazingrando amazingrando added 🪄 Enhancement New feature or request. 👉 Good First Issue A good issue or PR to start with. 📖 Needs Documentation labels Apr 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
📖 Needs Documentation 🪄 Enhancement New feature or request. 👉 Good First Issue A good issue or PR to start with.
Projects
Emulsify Project
Status: Backlog
Milestone
No milestone
Development

No branches or pull requests
2 participants
@amazingrando @mcortes19