NodeGoat
NodeGoat copied to clipboard
OWASP
We need a CONTRIBUTING Guide and CoC
Context
- This is part of
release-1.5#148 - Critical task
Tasks
- [x] Define a good a contributing guide (requirements/discussion)
- [ ] Add the information to
CONTRIBUTING.md - [x] Let's agree on a good Code of Conduct (CoC)
- [ ] Add the CoC to the
CONTRIBUTING.md - [ ] Update the
README.mdwith the new CoC and Contributing guide
Discussion
CoC
- I suggest to use the standard Contributor Covenant as it is available in many languages and it is widely adopted by +300k repos. I believe that 1.4 (latest version) is cool for us. Good F.A.Q too.
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.
- For extra info on "Why do I need a code of conduct?, etc..."
Contributing
- I believe that we can use this good example wrote by @PurpleBooth and later on we can add extra info about how do we want to manage GitFlow, merges, PRs, Issues labels...
- Other cool examples:
- The Atom editor contribution guidelines.
- The Ruby on Rails contribution guidelines.
- The Open Government contribution guidelines.
- The implementation seems super simple.
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
- Check the current roadmap #148
- Don't forget to check the Contributing Guidelines and follow the Code of Conduct
@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!
