Contributing to DeclarativeX 🛠️¶

Hey, Future Contributor! 👋¶

First off, thanks for considering contributing to DeclarativeX! Whether it's fixing bugs, adding new features, or improving documentation, every contribution counts, and I'm stoked to have you on board.

Ground Rules 📜¶

Before we dive in, let's set some ground rules to ensure a smooth and enjoyable contribution process for everyone:

Be Respectful: Let's keep the conversation friendly and professional.
Code of Conduct: Please follow our Code of Conduct to maintain a welcoming community.
Quality Over Quantity: We're all for contributions, but let's focus on quality rather than just ticking off numbers.

Getting Started 🚀¶

1. Fork the Repository¶

Start by forking the DeclarativeX repository to your GitHub account.

2. Set Up your local environment¶

Clone your forked repository to your local machine:

git clone https://github.com/<your-username>/declarativex.git
cd declarativex
poetry install

3. Create a branch¶

Create a new branch for your feature or bugfix:

git checkout -b <branch-name>

4. Make your changes¶

Now that you're all set up, you can start making your changes. Don't forget to commit them.

git add .
git commit -m "Add my awesome feature"

5. Run tests and linters¶

Before submitting your changes, make sure to run the tests and linters to ensure that everything is working as expected.

make

6. Submit a pull request¶

Push your changes to your fork and create a pull request.

Review Process 📝¶

All pull requests will be reviewed by the maintainers. If there are any comments or suggestions, you'll be notified through GitHub. Once everything is good to go, your pull request will be merged.

Recognition 🏆¶

We're all about giving credit where credit is due. All contributors will be recognized in the Hall of Fame section of the documentation.

Questions or Security Issues? 🤔¶

If you have any questions, feel free to reach out to use through issues. We're here to help!

Danger

If you discover a security vulnerability, please DON'T create an issue.

Instead create a topic in the Security Advisories!

We'll take care of it ASAP.

Thank You! 🙏¶

Once again, thanks for considering contributing to DeclarativeX. We're excited to see what you'll come up with!