Skip to content

Latest commit

 

History

History
executable file
·
112 lines (82 loc) · 5.75 KB

CONTRIBUTING.md

File metadata and controls

executable file
·
112 lines (82 loc) · 5.75 KB
Raw

Contributing Guidelines

This document contains information and guidelines about contributing to this project. Please read it before you start participating.

Topics

Asking Questions

We don't use GitHub as a support forum. For any usage questions that are not specific to the project itself, please ask on Stack Overflow instead. By doing so, you'll be more likely to quickly solve your problem, and you'll allow anyone else with the same question to find the answer. This also allows maintainers to focus on improving the project for others.

Reporting Security Issues

The developers of CDMarkdownKit takes security seriously. If you discover a security issue, please bring it to our attention right away!

Please DO NOT file a public issue, instead send your report privately to contact@christopherdehaan.me. This will help ensure that any vulnerabilities that are found can be disclosed responsibly to any affected parties.

Reporting Other Issues

A great way to contribute to the project is to send a detailed issue when you encounter an problem. We always appreciate a well-written, thorough bug report.

Check that the project issues database doesn't already include that problem or suggestion before submitting an issue. If you find a match, feel free to vote for the issue by adding a reaction. Doing this helps prioritize the most common problems and requests.

When reporting issues, please fill out our issue template. The information the template asks for will help us review and fix your issue faster.

Submitting Pull Requests

You can contribute by fixing bugs or adding new features. For larger code changes, we recommend first discussing your ideas on our GitHub Discussions.

Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

  • (a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or

  • (b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or

  • (c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.

  • (d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.

Code of Conduct

The Code of Conduct governs how we behave in public or in private whenever the project will be judged by our actions. We expect it to be honored by everyone who contributes to this project.

We strive to:

  • Be open: We invite anybody to participate in any aspect of our projects. Our community is open, and any responsibility can be carried by any contributor who demonstrates the required capacity and competence.
  • Be empathetic: We work together to resolve conflict, assume good intentions, and do our best to act in an empathic fashion. By understanding that humanity drops a few packets in online interactions, and adjusting accordingly, we can create a comfortable environment for everyone to share their ideas.
  • Be collaborative: We prefer to work transparently and to involve interested parties early on in the process. Wherever possible, we work closely with others in the open source community to coordinate our efforts.
  • Be decisive: We expect participants in the project to resolve disagreements constructively. When they cannot, we escalate the matter to structures with designated leaders to arbitrate and provide clarity and direction.
  • Be responsible: We hold ourselves accountable for our actions. When we make mistakes, we take responsibility for them. When we need help, we reach out to others. When it comes time to move on from a project, we take the proper steps to ensure that others can pick up where we left off.

This code is not exhaustive or complete. It serves to distill our common understanding of a collaborative, shared environment and goals. We expect it to be followed in spirit as much as in the letter.

The CDMarkdownKit Code of Conduct is licensed under the Creative Commons Attribution-Share Alike 3.0 License.

Some of the ideas and wording for the statements above were based on work by Mozilla, Ubuntu, and Twitter. We thank them for their work and contributions to the open source community.

Some of the ideas and wording for the statements above were based on work by the Docker and Linux communities. We commend them for their efforts to facilitate collaboration in their projects.