Skip to content

Latest commit

 

History

History
31 lines (16 loc) · 2.98 KB

CONTRIBUTING.md

File metadata and controls

31 lines (16 loc) · 2.98 KB

Contributing to the Code Connector Website

There are a few things to know before getting started contributing to this repository. Before getting into it, we'd like to thank you for your interest and let you know that we love contributions of any size and are here to support and welcome first time contributors!

Code of Conduct

This project and everyone participating in it is governed by the Code Connector Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to codeconnectorteam@gmail.com.

How can one contribute?

Reporting bugs, suggesting enhancements, providing your thoughts on pull requests and open issues, and contributing code through Pull Requests are all great ways to contribute to this repository.

Reporting a Bug

Issues are used to track bugs with this site. If you notice a bug when using the website, please file an issue using our Bug template. The template includes prompts for relevant information useful in debugging the issue. There's no need to identify the root cause or commit to opening a Pull Request with a fix. Simply reporting the bug is very useful and appreciated!

Suggesting Enhancements

Enhancements to this website are often discussed in our community Slack instance. If you are interested in discussing potentially large changes to the website, consider joining the #website-admin channel.

For enhancements of all sizes, a Github Issue should exist. If you have an idea that you would like to share, consider filing an issue using the Feature template. This includes prompts for relevant information that can help with prioritizing and clarifying your idea and rationale.

Commenting on Issues and Pull Requests

Sharing your opinions on open issues and pull requests, regardless of your experience level, is helpful to us as we develop this site. Diverse opinions and questions can uncover issues and spark conversation that results in improvements and learning that wouldn't happen without those comments.

Contributing Code

Before contributing code, identify the Github issue that this code is related to. If an issue doesn't exist yet, please file an issue for it to provide more context to the Code Connector team about what you are interested in changing. This can start conversation and save you time implementing something that may not be accepted by the Code Connector team. If an issue already exists, feel free to contribute code to resolve it.

Note: The good first issue label is applied to simpler issues that do not require previous experience or knowledge to tackle.