Skip to content

Latest commit

 

History

History
45 lines (29 loc) · 2.26 KB

CONTRIBUTING.md

File metadata and controls

45 lines (29 loc) · 2.26 KB

Contributing

Compile7 Blog is MIT licensed and accepts contributions via GitHub pull requests. This document outlines some of the conventions on development workflow, commit message formatting, contact points, and other resources to make it easier to get your contribution accepted.

Getting Started

  • Fork the repository on GitHub.
  • Read the blog post writing guidelines for writing and publishing your blog.
  • If you find any bug/typo/fix in our existing blog posts, please create a pull request as mentioned in Contribution Flow.

Contribution Flow

This is a rough outline of what a contributor's workflow looks like:

  • Create a separate branch from main branch to base your work.
  • Make commits of logical units.
  • Make sure your commit messages are in the proper format (see below).
  • Push your changes to a topic branch in your fork of the repository.
  • Make sure to proofread the content before submitting.
  • Submit a pull request to the original repository.
  • Please ensure that you raise a PR against main branch and not any other branch.

Commit Messages

Please follow the below format while writing commit messages:

  title: One line description about your change
  <Blank Line>
  description: An optional description of your changes.

Thanks for your contributions!

Code of Conduct

Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.

If you come across any instance or anyone breaching our code of conduct, report to us here.

Our Responsibilities

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.