Contributing Guide

Thank you for considering contributing to the zk Timeline Project! We welcome contributions of all types, whether you're adding new events, improving descriptions, or suggesting new features. This guide will help you get started.

How to Contribute

1. Fork the Repository

To contribute, first fork the repository to create your own copy.

2. Clone the Repository

Clone the repository to your local machine:

git clone https://github.com/YOUR_USERNAME/zktimeline.git

3. Create a New Branch

Create a new branch for your contribution:

git checkout -b feature/your-contribution

4. Make Changes

• Add a New Event: Add your new event to events.json. Ensure the format matches other events in the file.
• Improve Descriptions: If you're updating descriptions or adding details, make sure the content is accurate and well-sourced.
• Suggest Features: You can also suggest new features by creating a GitHub issue.

5. Commit Changes

Commit your changes with a meaningful commit message:

git add .
git commit -m "Add a new zk event for 2023"

6. Push Changes

Push your changes to your branch:

git push origin feature/your-contribution

7. Create a Pull Request

Go to the original repository on GitHub and create a Pull Request (PR). Include a clear description of your changes.

Contribution Tips

• Keep Changes Small: Make focused contributions to make reviewing easier.
• Follow Style Guides: Follow any existing styles for JSON, CSS, and JavaScript to keep the codebase consistent.
• Add Comments: Where necessary, add comments in the code to explain complex logic.

Reporting Issues

If you find any issues or bugs, please open an issue on GitHub with a detailed description so we can address it.

Code of Conduct

We want this project to be a welcoming and respectful community. Please be kind and considerate to others in your contributions.

---

Thank you for helping improve the zk Timeline Project! Your efforts are what make this project successful and valuable to the community.