Thank you for your interest in contributing to our project! This document outlines the guidelines for contributing to our project. Please read it carefully before making any contributions.
If you're new to contributing to this project or open source in general, please take a moment to read through the following resources:
We use GitHub issues to track tasks, bugs and feature requests. If you'd like to work on an issue, please comment on it to let us know. If you want to report a new issue, please follow these guidelines:
- Use a clear and descriptive title for the issue.
- Describe the steps to reproduce the issue, if applicable.
- Include screenshots or code samples if necessary.
- Specify the version of the software you're using.
We welcome pull requests from anyone who wants to improve our project. Before submitting a pull request, please make sure to do the following:
- Fork the repository and create a new branch for your changes.
- Ensure that your changes are consistent with our coding style and conventions.
- Write tests for any new functionality or fixes and ensure they pass.
- Document your changes in the
README.md
file, if necessary. - Submit a pull request to the
main
branch of the original repository.
In the interest of fostering an open and welcoming environment, we have adopted a Code of Conduct that we expect all contributors to adhere to.
This contributing guideline was adapted from the Contributor Covenant and Atom's contributing guidelines.