Skip to content

Latest commit

 

History

History
47 lines (29 loc) · 2.77 KB

CONTRIBUTING.md

File metadata and controls

47 lines (29 loc) · 2.77 KB
Raw

Contributing to FOSS Acronyms

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

The following is a set of guidelines for contributing to this project, which are hosted in the D-EDGE Organization on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Code of Conduct

This project and everyone participating in it is governed by the D-EDGE Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

Working on your first Pull Request?

You can learn how from this free series How to Contribute to an Open Source Project on GitHub

Git Commit Messages

This project follows a subset of Conventional commits specification. No type, no scope. Only description and so upper case the first letter.

What to contribute?

Fill gap

FOSS-Acronyms has a lot of blank space waiting to be filled. Find an empty string in one of the JSON and fix it!

image

Pro-tips: Open acronyms.json and search for "" 😄

Add new acronym

You can contribute by adding new entries to the list of acronyms.

  • Find a good missing acronym
    • Grab one in the issues. Issues are filled with good missing acronyms.
    • Submit your own. A missing acronym is an acronym not in the list nor in the issues. A good acronym is any acronym used by the FOSS community.
  • Fork the project. You can use this shortcut.
  • Edit the JSON. A good acronym need
    • an Abbreviation like "FOSS"
    • a Definition like "Free & Open Source Software"
    • a Usage like "That is both free software and open-source software where anyone is freely licensed to use, copy, study, and change the software in any way, and the source code is openly shared so that people are encouraged to voluntarily improve the design of the software"
    • an Example wich is a collection of html link like <a href=\"https://en.wikipedia.org/wiki/Free_and_open-source_software#Usage\">FOSS/FLOSS</a>. Don't forget to escape all the quote (e.g. \").
  • Submit a PR

Finally here is an example of a merged PR. Have fun hacking this project 😸

Thank you for contributing!