Contributing to P&H Neel Group Source Code

Step-by-Step Contribution Guide

1. Open an Issue

• Navigate to the Issues tab in the associated project repository on GitHub.
• Click New Issue to create a new issue.
• Clearly describe the feature, bug fix, or improvement you propose.
• Once done, submit the issue.

2. Assign the Issue to Yourself

• After creating the issue, assign it to yourself to let others know you're working on it.
• You can do this by clicking on the Assignees section on the right-hand side and selecting your username.

3. Open a Branch from the Issue

• Create a new branch in your local repository. The branch name should be descriptive and related to the issue.
• Use the following command to create and switch to your new branch:

  git fetch origin
  git checkout -b [branch-name]
  

4. Implement Your Changes

• Make your changes in the newly created branch. Be sure to stick to the coding standards and guidelines of the project.
• Once changes are complete, commit them to your branch.

5. Open a Pull Request (PR)

• Push your branch to the remote repository.
• Go to the Pull Requests tab in the GitHub repository and click New Pull Request.
• Compare your branch with the main branch and create the pull request.
• Ensure you provide a detailed description of your changes in the PR description.

6. Request a Review

• After opening a PR, request a review from a team member other than yourself.
• To do this, select a reviewer in the Reviewers section on the right-hand side of the PR page.

7. Merge into Main (after Approval)

• Once your PR is reviewed and approved, you can merge your changes into the main branch.
• Click on Merge Pull Request to complete the process.

Additional Guidelines

• Make sure to frequently sync your branch (git fetch origin) with the main branch to avoid merge conflicts.
• Adhere to the code of conduct and contributing guidelines of the project.
• If unsure, @isaiahharvi