Skip to content
  • Íñigo Huguet's avatar
    Add more detailed explanations for users, contributors and maintainers · 5481ba15
    Íñigo Huguet authored and Íñigo Huguet's avatar Íñigo Huguet committed
    README.md:
    
    As this document is mainly for normal users, and in Gitlab it's
    displayed by default, it's the main entry point to get information when
    someone get into the repo, either via web or cloned.
    
    Added explanations about how to install and use NM and how to find the
    documentation for users. Added brief info about how to report issues
    and ask for help, with links to CONTRIBUTING.md to get more details.
    
    Added brief link for potential contributors to read CONTRIBUTING.md.
    People not familiar with open source projects might not be aware of it.
    
    Deleted the "moved to freedesktop" message. After 15 years, people might
    know yet.
    
    Added brief explanation about the free software license.
    
    CONTRIBUTING.md:
    
    Added a link to the list of all communication channels, only mailing
    list and IRC were listed.
    
    Added detailed explanation about how to report issues and attach logs.
    It also references the new tool anonymize-logs.py.
    
    Added brief guidelines about how to start contributing choosing issues
    from the tracker.
    
    Fixed some small formatting issues and added a reference to nm-in-vm,
    fixing the link to nm-in-container too.
    
    MAINTAINERS.md:
    
    Added explanation about how to triage and properly label the issues.
    This is basically based on the kind-of-workflow that we already have,
    but maybe it's a good time to check that it's correct or to propose
    small changes (so, please propose changes in review).
    5481ba15
After you've reviewed these contribution guidelines, you'll be all set to contribute to this project.