Skip to content
This repository has been archived by the owner on Jun 12, 2023. It is now read-only.

Latest commit

 

History

History
73 lines (44 loc) · 1.85 KB

CONTRIBUTING.md

File metadata and controls

73 lines (44 loc) · 1.85 KB

Contributing to Darcy 🤝

We're glad that you're interested in contributing to Darcy! Whether you're a developer, designer, or just someone who wants to help out, there are many ways to get involved.

How to Contribute 🤔

Here are a few ways you can contribute to the Darcy project:

  • Report a bug: If you've found a bug in the code, please report it in the issue tracker.

  • Fix a bug: If you know how to fix a bug, please submit a pull request with your changes.

  • Add a feature: If you have an idea for a new feature, please open an issue to discuss it first. Once we've had a chance to discuss the feature, you can submit a pull request with your changes.

  • Help with documentation: If you're good at writing, you can help us improve the documentation.

  • Provide feedback: If you have ideas or suggestions for how we can improve Darcy, please let us know.

Code of Conduct 📜

All contributors are expected to follow the Code of Conduct.

Getting Started 💻

  1. Fork the repository:
https://github.com/darcyinc/darcy.git
  1. Clone the repository:
git clone https://github.com/[your-username]/darcy.git
  1. Navigate to the project directory:
cd darcy
  1. Install the dependencies:
pnpm install
  1. Create a new branch for your changes:
git checkout -b [branch-name]
  1. Make your changes and commit them:
git add .
git commit -m "[commit message]"
  1. Push your changes to your fork:
git push origin [branch-name]
  1. Open a pull request to the development branch.

Go to the Darcy repository on GitHub and click the "Compare & pull request" button. Fill out the form and submit your pull request.

Happy coding! 🚀💻