Skip to content

Community engagement

  • Invite people to learn about your projects: share your work at conferences, colleagues and former colleagues, through publications, and on social-media
  • Polish your README.md file. As it will give first impression of your project. It is not only instructions, but here you can talk about your goals and describe the vision of your project. Clearly communicate project's importance and challenges.
  • Make it easy to find: define right keywords (topics) for your project, so contributors can find it more easily in developer platforms such as GitLab or GitHub.
  • Have a running demo of your project (if applicable).
  • Make a Docker file and tutorial, so it is easy to build and run.
  • Have documentation that covers both the public interfaces (for users) and the key internal concepts (for future developers).
  • Make automated tests, have them run as part of your CI.
  • Include new contributors in your project's community by mentoring them and providing support, specially for the first-time contributors.
  • You are welcome to define a Code of Conduct; for certain contributors, CERN's code of conduct will also apply.
  • Establish contribution guidelines and community standards in a CONTRIBUTING.md file:
    • How to file a bug report
    • How to suggest a new feature
    • How to set up your environment and run tests
    • The types of contributions you’re looking for
    • Your roadmap or vision for the project
    • How contributors should (or should not) get in touch with you
  • Maintain good attitude:
    • Don't tolerate bad actors (bullying, aggression of any sort, dismissive behavior, etc); actively engage when you see it; share with people who saw this behavior that it's not tolerated, and then discuss this case privately with the bad actor. Point them to the code of conduct.
    • Be responsive.
    • Manage the conflicts between contributors

To learn more about building and sustaining community engagement, visit this guide