Skip to content

Latest commit

 

History

History
69 lines (46 loc) · 2.39 KB

CONTRIBUTING.md

File metadata and controls

69 lines (46 loc) · 2.39 KB
Raw

Thank you for your interest in contributing to the P4 Compiler tutorials repository! Your contributions are important and will help to improve the project for everyone. Before you begin, please consider the guidelines below.

Getting Started

  • Make sure you have Git installed on your machine.

  • Fork the repository and clone it locally.

    git clone https://github.com/<your_github_username>/tutorials.git

  • Create a new branch for your contributions

    git checkout -b feature-branch-name

Making Changes

  • Before making changes, ensure that you're working on the latest version of the master branch

    git pull origin master

  • Make your changes following the project's Coding conventions and guidelines.

Committing Changes

  • Stage your changes:

    git add file-name(s)

  • Commit your changes with a descriptive message:

    git commit -m "Add feature"

  • Push your changes to your forked repository:

    git push origin feature-branch-name

Submitting a Pull Request

Code Review

  • After submitting your PR, our team will review your changes.
  • Address any feedback or requested changes promptly.
  • Once approved, your PR will be merged into the master branch.

Finding a Task

  • Check out the issues that have specifically been labeled as help wanted
  • Have a look at the README.md Can it be improved? Do you see any typos? You may initiate a PR.

Reporting Issues

If you find any bugs or have recommendations for improvements, please feel free to open an issue with a detailed explanation of changes.

Contact

  • For further assistance or questions regarding contributions, feel free to join our Slack channel/Forum here

Thank you for contributing to P4 tutorials! We look forward to your contributions.