Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
93 lines (64 loc) · 4.14 KB

CONTRIBUTING.md

File metadata and controls

93 lines (64 loc) · 4.14 KB
Raw

Contributing to Data Communication

Thank you for your commitment to supporting Data Communication. Your contribution is vital in creating a collaborative platform that enhances the learning experience for students and researchers. Let's work together to build a resourceful environment where individuals can resolve queries and access the necessary materials for a comprehensive understanding of data communication concepts.

To ensure a smooth and effective contribution process, please review the following guidelines:

How to Contribute

  1. Raise an Issue or Get Assigned:

    • If you have an idea for a contribution or want to work on an existing issue, raise an issue to discuss it or get assigned to an existing one.
    # Example command for creating an issue using the GitHub CLI

  2. Fork the repository.

  3. Clone the forked repository to your local machine.

    git clone git@github.com:<your_username>/data-communication

  4. Install Requirements:

    • Before running or testing your changes, make sure to install the required dependencies. Navigate to the project directory and run:
    pip install -r requirements.txt

  5. Create a new branch for your changes.

    git checkout -b <branch-name>

  6. Make your changes and commit them.

    # Example commands for making changes and committing them
git add .
git commit -m "Description of your changes"

  7. Push your changes to your forked repository.

    git push origin <branch-name>

  8. Create a pull request to merge your changes into the main repository.

    • Once you've pushed your changes, open a pull request to propose the changes for review and inclusion.
    • Ensure that your pull request title and description are clear and concise.
    • Include a screenshot or GIF of your changes if applicable.
    • Include a link to the issue you are addressing in your pull request description.
    • If your pull request is related to an existing issue, include the issue number in the pull request description.

Contribution Guidelines

  • Be Clear and Concise:

    • Ensure that your contributions are clear and concise, making it easy for users to understand the content.

  • Focus on Data Communication Concepts:

    • When contributing, ensure that your changes and additions are relevant to data communication concepts, protocols, and technologies.

  • Provide Examples and Use Cases:

    • Whenever possible, include practical examples and use cases to help users understand the real-world applications of data communication principles.

  • Add Docstrings:

    • Include informative docstrings in every algorithm or code snippet you contribute. Docstrings should describe the purpose of the code, parameters, and return values. Follow the Google Python Style Guide for docstring conventions.

  • Check Pylint Status:

    • Before submitting a pull request, check the pylint status of your code using the following command:

      pylint */*.py

      Ensure that your code meets the pylint standards and fix any reported issues.

  • Follow Code of Conduct:

    • Respect the project's Code of Conduct. Ensure a friendly and inclusive environment for all contributors.

  • Test Your Changes:

    • Before submitting a pull request, thoroughly test your changes to ensure they work as intended.

  • Document Your Contributions:

    • Provide clear documentation for any new features or significant changes you introduce. This helps users and other contributors understand your contributions.

  • Seek Clarification:

    • If you are unsure about anything or need clarification, feel free to open an issue to discuss your ideas before making significant changes.

Code Review Process

All contributions will go through a code review process to maintain code quality and consistency. Please be patient during this process, and be open to feedback and suggestions.

Thank you for your dedication to improving the Data Communication learning experience. Your contributions are highly valued!