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

We need a CONTRIBUTING Guide and CoC #151

Open
2 of 5 tasks
UlisesGascon opened this issue Aug 5, 2019 · 2 comments
Open
2 of 5 tasks

We need a CONTRIBUTING Guide and CoC #151

UlisesGascon opened this issue Aug 5, 2019 · 2 comments
Assignees
Milestone

Comments

@UlisesGascon
Copy link
Collaborator

UlisesGascon commented Aug 5, 2019

Context

Tasks

  • Define a good a contributing guide (requirements/discussion)
  • Add the information to CONTRIBUTING.md
  • Let's agree on a good Code of Conduct (CoC)
  • Add the CoC to the CONTRIBUTING.md
  • Update the README.md with the new CoC and Contributing guide

Discussion

CoC

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.

Contributing

Assignation

  • This tasks is an important decision making, let's open discussion. I will transfer all the decisions to the files, but let's @ckarande help us to define what fits better for the project ^^

Extra Stuff

@ckarande
Copy link
Member

ckarande commented Aug 5, 2019

@UlisesGascon Thanks for adding this task. Yes, the Contributing Guidelines and the Code of Conduct are important as the number of contributors grow.

For CoC, I like your suggestion to use Contributor Covenant. Lets go with it.

For Contribution guidelines, right now we have a very short section on it. I am fine with adding a CONTRIBUTING.md and start simple by following the template created by @PurpleBooth. Sooner than later, we should add a section on coding style guide and checks to perform before making a PR to keep the code quality consistent.

Cheers!

@UlisesGascon
Copy link
Collaborator Author

Awesome! Thanks @ckarande. I will rise a PR asap with the changes

UlisesGascon added a commit to UlisesGascon/NodeGoat that referenced this issue Nov 6, 2019
- Added contributing guidelines
- Added CoC
- Updated Documentation
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants