├── LICENSE ├── README.md ├── code-of-conduct.md └── contributing.md /LICENSE: -------------------------------------------------------------------------------- 1 | CC0 1.0 Universal 2 | 3 | Statement of Purpose 4 | 5 | The laws of most jurisdictions throughout the world automatically confer 6 | exclusive Copyright and Related Rights (defined below) upon the creator and 7 | subsequent owner(s) (each and all, an "owner") of an original work of 8 | authorship and/or a database (each, a "Work"). 9 | 10 | Certain owners wish to permanently relinquish those rights to a Work for the 11 | purpose of contributing to a commons of creative, cultural and scientific 12 | works ("Commons") that the public can reliably and without fear of later 13 | claims of infringement build upon, modify, incorporate in other works, reuse 14 | and redistribute as freely as possible in any form whatsoever and for any 15 | purposes, including without limitation commercial purposes. These owners may 16 | contribute to the Commons to promote the ideal of a free culture and the 17 | further production of creative, cultural and scientific works, or to gain 18 | reputation or greater distribution for their Work in part through the use and 19 | efforts of others. 20 | 21 | For these and/or other purposes and motivations, and without any expectation 22 | of additional consideration or compensation, the person associating CC0 with a 23 | Work (the "Affirmer"), to the extent that he or she is an owner of Copyright 24 | and Related Rights in the Work, voluntarily elects to apply CC0 to the Work 25 | and publicly distribute the Work under its terms, with knowledge of his or her 26 | Copyright and Related Rights in the Work and the meaning and intended legal 27 | effect of CC0 on those rights. 28 | 29 | 1. Copyright and Related Rights. A Work made available under CC0 may be 30 | protected by copyright and related or neighboring rights ("Copyright and 31 | Related Rights"). Copyright and Related Rights include, but are not limited 32 | to, the following: 33 | 34 | i. the right to reproduce, adapt, distribute, perform, display, communicate, 35 | and translate a Work; 36 | 37 | ii. moral rights retained by the original author(s) and/or performer(s); 38 | 39 | iii. publicity and privacy rights pertaining to a person's image or likeness 40 | depicted in a Work; 41 | 42 | iv. rights protecting against unfair competition in regards to a Work, 43 | subject to the limitations in paragraph 4(a), below; 44 | 45 | v. rights protecting the extraction, dissemination, use and reuse of data in 46 | a Work; 47 | 48 | vi. database rights (such as those arising under Directive 96/9/EC of the 49 | European Parliament and of the Council of 11 March 1996 on the legal 50 | protection of databases, and under any national implementation thereof, 51 | including any amended or successor version of such directive); and 52 | 53 | vii. other similar, equivalent or corresponding rights throughout the world 54 | based on applicable law or treaty, and any national implementations thereof. 55 | 56 | 2. Waiver. To the greatest extent permitted by, but not in contravention of, 57 | applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and 58 | unconditionally waives, abandons, and surrenders all of Affirmer's Copyright 59 | and Related Rights and associated claims and causes of action, whether now 60 | known or unknown (including existing as well as future claims and causes of 61 | action), in the Work (i) in all territories worldwide, (ii) for the maximum 62 | duration provided by applicable law or treaty (including future time 63 | extensions), (iii) in any current or future medium and for any number of 64 | copies, and (iv) for any purpose whatsoever, including without limitation 65 | commercial, advertising or promotional purposes (the "Waiver"). Affirmer makes 66 | the Waiver for the benefit of each member of the public at large and to the 67 | detriment of Affirmer's heirs and successors, fully intending that such Waiver 68 | shall not be subject to revocation, rescission, cancellation, termination, or 69 | any other legal or equitable action to disrupt the quiet enjoyment of the Work 70 | by the public as contemplated by Affirmer's express Statement of Purpose. 71 | 72 | 3. Public License Fallback. Should any part of the Waiver for any reason be 73 | judged legally invalid or ineffective under applicable law, then the Waiver 74 | shall be preserved to the maximum extent permitted taking into account 75 | Affirmer's express Statement of Purpose. In addition, to the extent the Waiver 76 | is so judged Affirmer hereby grants to each affected person a royalty-free, 77 | non transferable, non sublicensable, non exclusive, irrevocable and 78 | unconditional license to exercise Affirmer's Copyright and Related Rights in 79 | the Work (i) in all territories worldwide, (ii) for the maximum duration 80 | provided by applicable law or treaty (including future time extensions), (iii) 81 | in any current or future medium and for any number of copies, and (iv) for any 82 | purpose whatsoever, including without limitation commercial, advertising or 83 | promotional purposes (the "License"). The License shall be deemed effective as 84 | of the date CC0 was applied by Affirmer to the Work. Should any part of the 85 | License for any reason be judged legally invalid or ineffective under 86 | applicable law, such partial invalidity or ineffectiveness shall not 87 | invalidate the remainder of the License, and in such case Affirmer hereby 88 | affirms that he or she will not (i) exercise any of his or her remaining 89 | Copyright and Related Rights in the Work or (ii) assert any associated claims 90 | and causes of action with respect to the Work, in either case contrary to 91 | Affirmer's express Statement of Purpose. 92 | 93 | 4. Limitations and Disclaimers. 94 | 95 | a. No trademark or patent rights held by Affirmer are waived, abandoned, 96 | surrendered, licensed or otherwise affected by this document. 97 | 98 | b. Affirmer offers the Work as-is and makes no representations or warranties 99 | of any kind concerning the Work, express, implied, statutory or otherwise, 100 | including without limitation warranties of title, merchantability, fitness 101 | for a particular purpose, non infringement, or the absence of latent or 102 | other defects, accuracy, or the present or absence of errors, whether or not 103 | discoverable, all to the greatest extent permissible under applicable law. 104 | 105 | c. Affirmer disclaims responsibility for clearing rights of other persons 106 | that may apply to the Work or any use thereof, including without limitation 107 | any person's Copyright and Related Rights in the Work. Further, Affirmer 108 | disclaims responsibility for obtaining any necessary consents, permissions 109 | or other rights required for any use of the Work. 110 | 111 | d. Affirmer understands and acknowledges that Creative Commons is not a 112 | party to this document and has no duty or obligation with respect to this 113 | CC0 or use of the Work. 114 | 115 | For more information, please see 116 | 117 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Awesome Computer Networking Resources [![Awesome](https://awesome.re/badge.svg)](https://awesome.re) 2 | An [awesome list](https://github.com/sindresorhus/awesome) of resources to design, implement and operate computer networks. 3 | 4 | # Contents 5 | - [Network Design Resources](#network-design-resources) 6 | - [Network Implementation](#network-implementation) 7 | - [Routing](#routing) 8 | - [Switching](#switching) 9 | - [VPN](#vpn) 10 | - [Network Services](#network-services) 11 | - [Network Simulators and Traffic Generators](#network-simulators-and-traffic-generators) 12 | - [Network Connectivity](#network-connectivity) 13 | - [Network Operations](#network-operations) 14 | - [Network Change Management](#network-change-management) 15 | - [Network Automation](#network-automation) 16 | - [Network Monitoring](#network-monitoring) 17 | - [Security Monitoring](#security-monitoring) 18 | - [Network Inventory](#network-inventory) 19 | - [Related resources](#related-resources) 20 | - [DevNet Tools](#devnet-tools) 21 | - [DevNet Monitoring](#devnet-monitoring) 22 | - [DevNet Knowledgebase](#devnet-knowledgebase) 23 | - [DevNet Inventory](#devnet-inventory) 24 | - [Knowledge Resources](#knowledge-resources) 25 | 26 | # Network Design Resources 27 | - [Cisco Design Zone](https://www.cisco.com/c/en/us/solutions/design-zone.html#~stickynav=1) 28 | - [Cumulus Networks Validated Design Guides](https://cumulusnetworks.com/learn/web-scale-networking-resources/?validated-design-guides) 29 | - [Juniper Solution Center](https://www.juniper.net/documentation/en_US/release-independent/solutions/information-products/pathway-pages/solutions/index.html) 30 | 31 | # Network Implementation 32 | ## Routing 33 | - [Free Range Routing](https://frrouting.org/) - IP routing protocol suite for Linux and Unix platforms which 34 | includes protocol daemons for BGP, IS-IS, LDP, OSPF, PIM, and RIP. 35 | - [VyOS](https://vyos.io/) - Open source network operating system that can be installed on physical hardware or a virtual machine on your own server, or a cloud platform. 36 | 37 | ### SD-WAN 38 | - [Silver Peak](https://www.silver-peak.com/) - SD-WAN Solution(Commercial). 39 | ## Switching 40 | - [snabb](https://github.com/snabbco/snabb) - Snabb (formerly "Snabb Switch") is a simple and fast packet networking toolkit. 41 | 42 | ## VPN 43 | - [Firezone](https://github.com/firezone/firezone) - Open-source VPN server and egress firewall for Linux built on WireGuard. Firezone is easy to set up (all dependencies are bundled thanks to Chef Omnibus), secure, performant, and self hostable. 44 | - [PiVPN](https://www.pivpn.io/) - Simplest OpenVPN setup and configuration, designed for Raspberry Pi. 45 | 46 | ## Network Services 47 | - [Pi-Hole](https://pi-hole.net/) - Network-wide ad blocking via your own Linux hardware. 48 | - [PortNox](https://www.portnox.com/pricing/) - Network Access Control as a Service (Commercial) 49 | - [Bunny.net](https://bunny.net/) - Global Content Delivery Platform 50 | 51 | ## Network Simulators and Traffic Generators 52 | - [GNS3](https://www.gns3.com/) - Network software emulator that allows the combination of virtual and real devices, used to simulate complex networks. 53 | - [Mininet](http://mininet.org/) - Instant Virtual Network on your Laptop. 54 | - [WANem](http://wanem.sourceforge.net/) - Wide Area Network Emulator. 55 | - [Ostinato](https://ostinato.org/) - Packet crafter, network traffic generator and analyzer with a friendly GUI. 56 | - [SIPp](http://sipp.sourceforge.net/index.html) - Free Open Source test tool / traffic generator for the SIP protocol. 57 | - [StarTrinity SIP Tester™](https://startrinity.com/VoIP/SipTester/SipTester.aspx) - VoIP monitoring and testing tool, VoIP recorder. 58 | - [Multi-Generator](https://github.com/USNavalResearchLaboratory/mgen) - Open source software that provides the ability to perform IP network performance tests and measurements using TCP and UDP/IP traffic. 59 | - [Network-Conditions-Emulator](https://github.com/marty90/Network-Conditions-Emulator) - Artificially limit uplink and downlink bandwidth, delay and loss rate on selected interfaces. 60 | - [snabb](https://github.com/snabbco/snabb) - Snabb (formerly "Snabb Switch") is a simple and fast packet networking toolkit. 61 | - [vqfx10k-vagrant](https://github.com/juniper/vqfx10k-vagrant) - Vagrant files to bring up Juniper virtual QFX instances. 62 | - [Packet Communication Investigator](https://github.com/michoo/pci) - import network traffic into a graphtool to analyse packet interactions between machines and network. 63 | - [SafePcap](https://omnipacket.com/safepcap) - GDPR and NISTIR 8053 Compliance for your Pcap files. 64 | - [Arkime](https://github.com/arkime/arkime) - Arkime augments your current security infrastructure to store and index network traffic in standard PCAP format, providing fast, indexed access. 65 | - [pyNTM](https://pyntm.readthedocs.io/en/latest/index.html) - a network traffic modeler written in python 3. 66 | 67 | ## Network Connectivity 68 | - [Packetfabric](https://packetfabric.com/) - Network as a service provider (commercial) 69 | - [Prosimo](https://prosimo.io/) - Autonomous Multi-Cloud Network (commercial) 70 | - [Subtelforum Online Map](https://subtelforum.com/online-map/) - Submarine cables map 71 | - [Megaport](https://www.megaport.com/) - Network as a Service (NaaS) platform (commercial) 72 | 73 | # Network Operations 74 | ## Network Change Management 75 | - [Batfish](https://github.com/batfish/batfish) - Network configuration analysis tool that can find bugs and guarantee the correctness of (planned or current) network configurations. 76 | - [Oxidized](https://github.com/ytti/oxidized) - Network device configuration backup tool. It's a [RANCID](https://www.shrubbery.net/rancid/) replacement. 77 | - [Netshot](http://www.netfishers.onl/netshot) - Network configuration and compliance management software. 78 | - [Jazigo](https://github.com/udhos/jazigo) - Jazigo is a tool written in Go for retrieving configuration for multiple devices, similar to rancid, fetchconfig, oxidized, Sweet. 79 | - [fetchconfig](https://github.com/udhos/fetchconfig) - fetchconfig is a Perl script for retrieving configuration of 80 | multiple devices. 81 | - [sweet](https://github.com/AppliedTrust/sweet) - Network device configuration backups and change alerts for the 21st century - inspired by RANCID. 82 | - [stockpiler](https://github.com/lykinsbd/stockpiler) - Stockpiler gathers network device configurations and stores them in a local Git repository. 83 | - [Jerikan](https://github.com/jerikan-network) - a configuration management system for network teams 84 | 85 | ## Network Automation 86 | - [Napalm](https://napalm-automation.net/) - Vendor neutral, cross-platform open source project that provides a unified API to network devices. 87 | - [netmiko](https://github.com/ktbyers/netmiko) - Multi-vendor library to simplify Paramiko SSH connections to network devices. 88 | - [trigger](https://github.com/trigger/trigger) - Robust network automation toolkit written in Python that was designed for interfacing with network devices. 89 | - [Ansible](https://github.com/ansible/ansible) - IT automation platform that makes your applications and systems easier to deploy by using SSH, with no agents to install on remote systems. 90 | - [nornir](https://github.com/nornir-automation/nornir) - Pluggable multi-threaded framework with inventory management to help operate collections of devices. 91 | - [CNaaS-NMS](https://github.com/SUNET/cnaas-nms) - Campus Network-as-a-Service - Network Management System. Software to automate management of a campus network (LAN). 92 | - [pyats](https://developer.cisco.com/pyats/) - pyATS enable network engineers to perform stateful validation of their device operational status. 93 | - [itential.com](https://www.itential.com/) - Low-Code Automation for Physical, Virtual, and Cloud Networks(commercial). 94 | - [AWX](https://github.com/ansible/awx) - the upstream project for Tower, a commercial derivative of AWX. 95 | - [Unimus](https://unimus.net/) Unimus makes Network Automation and Configuration Management easy (commercial). 96 | - [Blackbox](https://backbox.com/) - Network automation for the hybrid multi-cloud era (commercial). 97 | - [Nephio](https://nephio.org/) - Nephio’s goal is to deliver carrier-grade, simple, open, Kubernetes-based cloud native intent automation and common automation templates. 98 | - [GitNOps](https://github.com/mcgonagle/GitNops) - GitNops is an operational framework that takes DevOps best practices used for application development such as version control, collaboration, compliance, and CI/CD, and applies them to network automation. 99 | 100 | ## Network Monitoring 101 | - [perfSONAR](https://www.perfsonar.net) - Network measurement toolkit designed to provide federated coverage of paths, and help to establish end-to-end usage expectations. 102 | - [UDPing](https://github.com/yahoo/UDPing) - Measure latency and packet loss across a link. 103 | - [Vaping](https://github.com/20c/vaping) - vaping is a healthy alternative to smokeping. 104 | - [veryflow](https://www.veriflow.net/) - Continuous network verification system. 105 | - [Forward Networks](https://www.forwardnetworks.com/) - Network Behavior Analysis (Commercial). 106 | - [ToDD](https://github.com/toddproject/todd) - Distributed, testing-on-demand system focused on testing network related conditions. 107 | - [pmacct](http://www.pmacct.net/) - Small set of multi-purpose passive network monitoring tools, including Netflow or IPFIX generation. 108 | - [LibreNMS](https://www.librenms.org/) - Network monitoring system that supports automatic discovery, alerting, distributed polling and others. 109 | - [Observium](https://observium.org/) - Low-maintenance auto-discovering network monitoring platform. 110 | - [Elastiflow](https://github.com/robcowart/elastiflow) - Netflow collector and reporting. 111 | - [vFlow](https://github.com/EdgeCast/vflow) - High-performance, scalable and reliable IPFIX, sFlow and Netflow collector (written in pure Golang). 112 | - [goFlow](https://github.com/cloudflare/goflow) - a NetFlow/IPFIX/sFlow collector in Go. 113 | - [BGPAlerter](https://github.com/nttgin/BGPalerter) - Self-configuring BGP monitoring tool 114 | - [xpresso](https://github.com/CiscoTestAutomation/xpresso) - the standard pyATS UI dashboard 115 | 116 | ## Security Monitoring 117 | - [cPacket](https://www.cpacket.com) - Performance monitoring solutions that deliver real-time analysis and coverage (Commercial). 118 | - [Proxmox Mail Gateway](https://www.proxmox.com/en/proxmox-mail-gateway) - Open-source email security solution helping you to protect your mail server against all email threats the moment they emerge. 119 | - [FastNetMon](https://fastnetmon.com/) - DDoS detection tool (Open Source or Commercial). 120 | - [PyREBox](https://github.com/Cisco-Talos/pyrebox) - Python scriptable Reverse Engineering Sandbox, a Virtual Machine instrumentation and inspection framework based on QEMU. 121 | - [Canary](https://canary.tools/) - Honeypot solution (commercial). 122 | - [CanaryTokens](https://canarytokens.org/generate) - Free honeytoken. 123 | - [Malcolm](https://github.com/idaholab/Malcolm) - Malcolm is a powerful, easily deployable network traffic analysis tool suite for full packet capture artifacts (PCAP files) and Zeek logs. 124 | - [Zeek](https://zeek.org/) - Zeek is an open source network security monitoring tool. 125 | - [zeek2es](https://github.com/corelight/zeek2es) - A Zeek log to Elastic/OpenSearch log converter. 126 | - [DrKeithJones.com](https://drkeithjones.com) - Keith Jones' blog on cyber security and security monitoring. 127 | 128 | ## Network Inventory 129 | - [phpipam](https://phpipam.net/) - Open-source web IP address management application (IPAM). 130 | - [nsot](https://github.com/dropbox/nsot) - Network Source of Truth is an open source IPAM and network inventory database. 131 | - [netbox](https://github.com/digitalocean/netbox) - IP address management (IPAM) and data center infrastructure management (DCIM) tool. 132 | - [ipfabric](https://ipfabric.io/product/network-mapping) - Network Topology Mapping & Visualization (Commercial). 133 | - [drawthe.net](https://github.com/cidrblock/drawthe.net) - Draws network diagrams dynamically from a text file describing the placement, layout and icons. 134 | 135 | ## Networking Labs 136 | - [VIRL](https://learningnetworkstore.cisco.com/virlfaq) - Virtual Internet Routing Lab by Cisco. 137 | - [dCloud](https://dcloud.cisco.com/) - Fully scripted, customizable environments available almost instantly in the cloud for free. 138 | - [Cisco DevNet Labs](https://developer.cisco.com/site/sandbox/) - Cisco's sandboxing environment 139 | 140 | # Related resources 141 | ## DevNet Tools 142 | - [Celery](http://www.celeryproject.org/) - Asynchronous task queue/job queue based on distributed message passing. It is focused on real-time operation, but supports scheduling as well. 143 | - [Ajenti](https://ajenti.org/) - Manage a remote Linux box at any time using everyday tools like a web terminal, text editor, file manager and others. 144 | - [ProxMox Virtualiation Platform](https://www.proxmox.com/en/proxmox-ve) - Open-source platform for enterprise virtualization that tightly integrates KVM hypervisor and LXC containers, software-defined storage and networking functionality on a single platform, and easily manages high availability clusters and disaster recovery tools with the built-in web management interface. 145 | - [ops_tcpdump_handler](https://github.com/cerner/ops_tcpdump_handler) - Chef Cookbook to test network connectivity . 146 | - [chromaterm](https://github.com/hSaria/ChromaTerm) - ChromaTerm is a Python module and script used for coloring the output to terminals. 147 | - [telnetmyip.com](https://telnetmyip.com/) - Simple service that returns your source IP information in a json format. 148 | - [icanhaztraceroute.com](https://icanhaztraceroute.com/) - Simple service that returns a traceroute back to your source IP. 149 | - [Who is my ISP?](https://www.whoismyisp.org) - Simple service that shows the ISP of an IP. 150 | - [NsLookup.io](https://www.nslookup.io) - Simple service that shows all DNS records for a domain name. 151 | - [netshoot](https://github.com/nicolaka/netshoot) - a Docker + Kubernetes network trouble-shooting swiss-army container. 152 | - [netshoot](https://github.com/nicolaka/netshoot) - a Docker + Kubernetes network trouble-shooting swiss-army container. 153 | - [DNSlookup](https://dnslookup.pro/) - Easy DNS lookup Tools 154 | - [What is my isp](https://whois-myisp.com/) - tool to find ISP name 155 | 156 | ## DevNet Monitoring 157 | - [netdata](https://github.com/firehol/netdata) - Distributed real-time performance and health monitoring. 158 | - [Grafana](https://grafana.com/) - Open source software for time series analytics. 159 | - [monit](https://mmonit.com/monit/) -Small Open Source utility for managing and monitoring Unix systems. Monit conducts automatic maintnance and repair and can execute meaningful causal actions in error situations. 160 | - [Prometheus](https://prometheus.io/) - Open-source systems monitoring and alerting toolkit originally built at SoundCloud. 161 | - [sensu](https://sensuapp.org/) - Monitor servers, services, application health, and business KPIs. Collect and analyze custom metrics. Get notified about failures before your users do. Give your business the competitive advantage it deserves. (Open Source or Commercial). 162 | - ELK Stack 163 | - [Elasticsearch](https://github.com/elastic/elasticsearch) - Open Source, Distributed, RESTful Search Engine. 164 | - [LogStash](https://github.com/elastic/logstash) - Transport and process your logs, events, or other data. 165 | - [Kibana](https://github.com/elastic/kibana) - Analytics and search dashboard for Elasticsearch. 166 | - [Graylog](https://www.graylog.org/) - Parse and enrich logs, wire data, and event data from any data source (Commercial, Free for less than 5GB/day). 167 | 168 | ## DevNet Knowledgebase 169 | - [ITGlue](https://www.itglue.com/) - IT focused documentation solution (Commercial). 170 | 171 | ## DevNet Inventory 172 | - [Snipe IT](https://snipeitapp.com/) - Open Source Asset Management tool. 173 | 174 | ## Knowledge Resources 175 | - [Packet Pushers Podcast](https://packetpushers.net/) - Podcast about data networking by network architects. Deeply technical & unabashedly nerdy. 176 | - [Risky Business Podcast](https://risky.biz/) - Features news and in-depth commentary from security industry luminaries. 177 | - [Software Gone Wild Podcast](https://www.ipspace.net/Podcast/Software_Gone_Wild/) - Software Gone Wild is focusing on architectures, solutions and technologies that real networking engineers use in production networks. 178 | - [Cisco DevNet Basics](https://developer.cisco.com/video/net-prog-basics) - Learn network programmability basics. 179 | - [Cisco Tools](https://www.cisco.com/c/en/us/support/web/tools-catalog.html) - List of Cisco tools maintained by Cisco. 180 | - [Juniper Day One Books](https://www.juniper.net/documentation/jnbooks/us/en/day-one-books) - Day One Books cover networking technologies using step-by-step instructions and practical examples written by working engineers 181 | 182 | 183 | -------------------------------------------------------------------------------- /code-of-conduct.md: -------------------------------------------------------------------------------- 1 | # Contributor Covenant Code of Conduct 2 | Please note that this code follows the [Awesome Code of Conduct](https://github.com/sindresorhus/awesome/blob/master/code-of-conduct.md) 3 | 4 | ## Our Pledge 5 | 6 | In the interest of fostering an open and welcoming environment, we as 7 | contributors and maintainers pledge to making participation in our project and 8 | our community a harassment-free experience for everyone, regardless of age, body 9 | size, disability, ethnicity, gender identity and expression, level of experience, 10 | nationality, personal appearance, race, religion, or sexual identity and 11 | orientation. 12 | 13 | ## Our Standards 14 | 15 | Examples of behavior that contributes to creating a positive environment 16 | include: 17 | 18 | * Using welcoming and inclusive language 19 | * Being respectful of differing viewpoints and experiences 20 | * Gracefully accepting constructive criticism 21 | * Focusing on what is best for the community 22 | * Showing empathy towards other community members 23 | 24 | Examples of unacceptable behavior by participants include: 25 | 26 | * The use of sexualized language or imagery and unwelcome sexual attention or 27 | advances 28 | * Trolling, insulting/derogatory comments, and personal or political attacks 29 | * Public or private harassment 30 | * Publishing others' private information, such as a physical or electronic 31 | address, without explicit permission 32 | * Other conduct which could reasonably be considered inappropriate in a 33 | professional setting 34 | 35 | ## Our Responsibilities 36 | 37 | Project maintainers are responsible for clarifying the standards of acceptable 38 | behavior and are expected to take appropriate and fair corrective action in 39 | response to any instances of unacceptable behavior. 40 | 41 | Project maintainers have the right and responsibility to remove, edit, or 42 | reject comments, commits, code, wiki edits, issues, and other contributions 43 | that are not aligned to this Code of Conduct, or to ban temporarily or 44 | permanently any contributor for other behaviors that they deem inappropriate, 45 | threatening, offensive, or harmful. 46 | 47 | ## Scope 48 | 49 | This Code of Conduct applies both within project spaces and in public spaces 50 | when an individual is representing the project or its community. Examples of 51 | representing a project or community include using an official project e-mail 52 | address, posting via an official social media account, or acting as an appointed 53 | representative at an online or offline event. Representation of a project may be 54 | further defined and clarified by project maintainers. 55 | 56 | ## Enforcement 57 | 58 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 59 | reported by contacting the project team at sindresorhus@gmail.com. All 60 | complaints will be reviewed and investigated and will result in a response that 61 | is deemed necessary and appropriate to the circumstances. The project team is 62 | obligated to maintain confidentiality with regard to the reporter of an incident. 63 | Further details of specific enforcement policies may be posted separately. 64 | 65 | Project maintainers who do not follow or enforce the Code of Conduct in good 66 | faith may face temporary or permanent repercussions as determined by other 67 | members of the project's leadership. 68 | 69 | ## Attribution 70 | 71 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, 72 | available at [http://contributor-covenant.org/version/1/4][version] 73 | 74 | [homepage]: http://contributor-covenant.org 75 | [version]: http://contributor-covenant.org/version/1/4/ 76 | -------------------------------------------------------------------------------- /contributing.md: -------------------------------------------------------------------------------- 1 | # Contribution Guidelines 2 | 3 | - Contributions can be made as Pull Requests 4 | - Use the following format: [Name](link) - Description. 5 | - New items must be added to the proper category but feel free to submit any improvement to the list in the PRs 6 | - Link to official links - when available, use github. 7 | 8 | --------------------------------------------------------------------------------