CONTRIBUTING.md

Contributing to Flock

Thank you for considering contributing to Flock! We welcome contributions from the community to help make this project even better.

How Can You Contribute?

There are several ways you can contribute to Flock:

1. Code Contributions:

   • Implement new features or enhancements.
   • Fix bugs and issues.
   • Improve code quality through refactoring.
   • Write and improve documentation.

2. Testing:

   • Test the project on different environments and report any issues.
   • Write unit tests to ensure the stability of the codebase.

3. Feedback:

   • Provide feedback on the project's features, usability, and documentation.
   • Suggest improvements or new ideas.

Getting Started

If you're new to contributing to open-source projects, here's how you can get started:

1. Fork the repository to your GitHub account.

2. Clone the forked repository to your local machine:

   git clone https://github.com/yourusername/flock.git
   cd flock

3. Create a new branch for your contribution:

   git checkout -b feature/new-feature

4. Make your changes, following the coding guidelines and best practices.

5. Commit your changes:

   git commit -m "Add new feature"

6. Push your changes to your forked repository:

   git push origin feature/new-feature

7. Open a pull request (PR) against the master branch of the original Flock repository.

Coding Guidelines

• Follow the PEP 8 style guide for Python code.
• Write clear and concise commit messages.
• Ensure your code passes any existing unit tests.
• Include relevant documentation for your changes.

Code of Conduct

Please note that by participating in this project, you agree to abide by our Code of Conduct.

Questions or Feedback?

If you have any questions or feedback, please don't hesitate to reach out by creating an issue or sending an email to shashwatsswain@gmail.com.

We appreciate your contributions and look forward to making Flock even better together!