Skip to content

Latest commit

 

History

History
50 lines (33 loc) · 2.47 KB

CONTRIBUTING.md

File metadata and controls

50 lines (33 loc) · 2.47 KB

Contributing to Egyptian Open Source Contribution Analysis

We welcome contributions to the Egyptian-Open-Source-Contribution-Analysis project! Whether you're a seasoned developer or just starting out, your help is valuable.

Ways to Contribute

Here are some ways you can contribute:

  • Bug Fixes: Found a bug or issue? Submit a pull request with a fix.
  • Feature Requests: Have an idea for a new feature or enhancement? Open an issue to discuss it.
  • Documentation Improvements: Improve existing documentation or add new documentation to make the project easier to understand and use.
  • Data Collection & Analysis: Contribute new data sources or refine existing data analysis techniques.
  • Visualization Enhancements: Create new visualizations or improve existing ones for better insights.

Contributing Guide

  1. Fork the repository: Create a fork of the repository on your GitHub account.
  2. Create a branch: Create a new branch from the main branch to work on your changes.
  3. Make your changes: Make the necessary code changes, documentation updates, or data additions.
  4. Test your changes: Ensure that your changes work as expected by running the tests.
  5. Commit your changes: Commit your changes with a clear and descriptive commit message.
  6. Push to your fork: Push your changes to your forked repository.
  7. Submit a pull request: Submit a pull request to the original repository, explaining your changes and addressing any issues.

Code Style

  • Follow the PEP 8 style guide for Python code.
  • Use a consistent coding style throughout the project.
  • Write clear and concise code that is easy to understand and maintain.

Documentation

  • Update the documentation with any changes you make to the code or data.
  • Write clear and concise documentation that is easy to understand for other developers.

Pull Requests

  • Please ensure your pull request has a clear and concise title.
  • Provide a detailed description of your changes and the rationale behind them.
  • Address any comments or feedback from the reviewers.

Code of Conduct

Please be respectful and professional in all interactions. We expect all contributors to follow the Contributor Covenant.

Questions

If you have any questions or need help, please don't hesitate to open an issue or contact the project maintainers.

Thank you for your contributions! We appreciate your support and look forward to collaborating with you.