contributing.md

Contributing to Zenscripts

We welcome contributions to Zenscripts! This document outlines the guidelines for contributing to the project.

Getting Started

1. Fork the repository: Create a fork of the Zenscripts repository on GitHub.
2. Clone your fork: Clone your forked repository to your local machine.

Making a Contribution

1. Identify an Issue or Feature:
   • Check existing issues for similar requests.
   • Open a new issue if necessary.
2. Create a Branch: Create a new branch for your changes.
3. Implement your Changes:
   • Follow coding conventions.
   • Write clear documentation.
   • Consider writing unit tests.
4. Commit your Changes:
   • Use conventional commits.
   • Example: fix: handle invalid user input gracefully (#123)
5. Push your Changes: Push your changes to your forked branch.
6. Create a Pull Request: Open a pull request to the main branch.

Coding Conventions

• File Naming: Use lowercase, hyphen-separated names (e.g., process_data.py).
• Variable Naming: Use camelCase (e.g., processData, getUserInput).
• Terminal Output: Format all user-facing output to lowercase.
• Questions: Use [?] question (y/n): format.
• Notifications/Messages: Use [*] message. format.
• Processes: Use numbered steps:

[*]  processing data...
[*] -> step 1: extract data from file -(1)
[*] -> step 2: clean and validate data -(2)
[*] -> step 3: perform calculations -(3)

General Guidelines

• Write clean, well-formatted code.
• Write clear and concise comments.
• Test your code thoroughly.
• Be respectful and follow the Code of Conduct.

We appreciate your contributions!

Feel free to reach out to the maintainers for any questions.