Upgrade to Pro — share decks privately, control downloads, hide ads and more …

Inclusive contribution guidelines for Open sou...

Avatar for Anita-Ihuman Anita-Ihuman
March 15, 2021
37

Inclusive contribution guidelines for Open source projects

The presentation is centred on the current state of contribution guidelines and how they can be improved

Avatar for Anita-Ihuman

Anita-Ihuman

March 15, 2021
Tweet

Transcript

  1. ANITA IHUMAN Software Developer, Technical writer, Open source biggest fan,

    Cat lover Twitter: Anita_ihuman, Github: Anita-ihuman Connect via:
  2. What are contribution guidelines? It a text file, created by

    the project maintainers which contains guidelines on how people should contribute to that project.
  3. PROBLEMS WITH MOST CONTRIBUTION GUIDELINES e a d b c

    Too technical Not enough Details Not interactive Difficult to access Hard to read through
  4. a c WHY SHOULD WE IMPROVE CONTRIBUTION GUIDELINE? The first

    time contributor can be a code maintainer tomorrow To create a welcoming environment For sakes of references. b
  5. 1 2 3 4 Translate documentation in various Languages. Make

    the tutorials on project setup interactive: Avoid too many technical terms: Make contribution guidelines obvious:
  6. Build a bridge: 5 Ensure that your guidelines contain complete

    information 6 It should specify how to reach for help: 6 It should be welcoming to everyone {whether designers or developers and writers} 7