Skip to content

Latest commit

 

History

History
62 lines (41 loc) · 2.34 KB

contributions.md

File metadata and controls

62 lines (41 loc) · 2.34 KB

Contributing to Dataherald Community App 🚀

We appreciate your interest in contributing to the Dataherald Community App! Your contributions help make our project even better. Whether you're a developer, designer, tester, or documentation enthusiast, there are many ways you can get involved.

How to Contribute 🤝

1. Fork the Repository 🍴

If you haven't already, start by forking the Dataherald Community App repository to your own GitHub account. This will create a copy of the project that you can freely experiment with.

2. Clone the Repository 📦

Clone your forked repository to your local machine using the following command:

git clone https://github.com/yourusername/streamlit-app.git

3. Create a Branch 🌿

Before making changes, create a new branch to work on your feature or bug fix:

cd streamlit-app
git checkout -b feature-name

4. Make Changes 🛠️

Now you can start making your contributions. Whether it's coding, design, or documentation updates, your work is valued.

5. Test Your Changes ✔️

If you're adding new features or modifying existing ones, be sure to test your changes thoroughly to ensure they work as expected.

6. Commit Your Changes 📝

Commit your changes to your branch with clear, concise commit messages:

git commit -m "Add cool new feature"

7. Push Your Changes 🚀

Push your changes to your forked repository:

shell

git push origin feature-name

8. Create a Pull Request 🙌

Once your changes are ready, go to the original Dataherald Community App repository on GitHub. Click the "New Pull Request" button, and you'll be able to submit your changes for review.

9. Review and Collaboration 🤓

Your pull request will be reviewed by the maintainers and contributors. They may provide feedback or ask for further changes. Be open to collaboration and improvement suggestions.

10. Merge and Celebrate 🎉

Once your pull request is approved, it will be merged into the main project. Congratulations, your contribution is now part of Dataherald Community App! 🚀

Roadmap 🗺️

If you're interested in the project's future plans and enhancements, following are the next steps we have ahead of us:

1. Adding the feature to add database connection

2. Adding some golden records to the app for the current database connections