Skip to content

Latest commit

 

History

History
52 lines (34 loc) · 3.12 KB

CONTRIBUTING.md

File metadata and controls

52 lines (34 loc) · 3.12 KB
Raw

Open Source by Pieces Contributor Guidelines

We are beyond excited that you want to contribute regardless of your skill-level! We would love to accept your contributions. Open Source by Pieces is built for the community and warmly welcomes collaboration. There are many ways in which one could contribute to Pieces Open Source, and every contribution is equally appreciated here. Navigate through the following to understand more about contributing.

And if you are new to the open source community or ecosystem, we will guide you through. If you are unfamiliar with the Pieces Product Suite - learn more about it here.

We aim to make our AI solution inclusive and easy to use as possible and this is a huge effort so dear contributors, welcome onboard!

General Contribution Flow

Contributing Guidelines

Firstly, thank you for considering contributing to Pieces Open Source. This guide details the general information that one should know before contributing to the repository. Please stick as closely as possible to the guidelines. That way, we ensure that you have a smooth experience contributing to this project.

General Rules:

These are, in general, rules that you should be following while contributing to an Open-Source Pieces project:

  • Be Nice, Be Respectful (BNBR)
  • Check if the Issue you created already exists or not
  • When creating a new issue, make sure you describe the issue clearly
  • Use tags to mark your issue as “draft” (we will remove the draft tag once we assign the proper issue tags to the created issue)
  • Make proper commit messages and document your PR well
  • Always add comments to your code
  • Follow proper code conventions because writing clean code is important
  • Add @jordan-pieces as a reviewer to be assigned to another maintainer or to be reviewed
  • Issues will be assigned on a "First Come, First Served" basis
  • Once an issue has been assigned, if we don’t receive any reply/response in a week, we will reassign the issue to someone else and remove the assignee
  • Do mention (@jordan-pieces) the project maintainer if your PR isn't reviewed within three days

Getting Started

Pre-requisites

Ensure you have the latest version of Pieces OS installed on your system:

View Open Task/Issues

The issues section is the best place to raise issues or bugs you find within the projects. Click here to view all open issues on all our open source projects.

Tutorials that may help you:

Be Part of Our Community

We are always ready to work with you and help you as you make your first contribution so join our amazing community and be part of our open source talks, meetups, etc.