Skip to content

Latest commit

 

History

History
71 lines (50 loc) · 2.24 KB

CONTRIBUTING.md

File metadata and controls

71 lines (50 loc) · 2.24 KB

Contribution Guidelines

Thank you for considering contributing to ReferralNetworkHub! By participating in this project, you agree to abide by the code of conduct.

How to Contribute

  1. Fork the repository to your GitHub account.

  2. Clone the forked repository to your local machine.

    git clone https://github.com/YourUsername/ReferralNetworkHub.git
  3. Create a new branch for your feature, resolved issue, or bug fix.

    • For a new feature, create a new branch with the following format:

      git checkout -b feature/new-feature-<name>
    • For a resolved issue, create a new branch with the following format:

      git checkout -b issue/resolved-issue-<name>
    • For a bug fix, create a new branch with the following format:

      git checkout -b bug/bug-fix-<name>
  4. Make changes to the codebase and commit them to your branch.

    git add .
    git commit -m "Your commit message"
  5. Push your changes to your forked repository.

    • For a new feature:

      git checkout -b feature/new-feature-<name>
    • For a resolved issue:

      git checkout -b issue/resolved-issue-<name>
    • For a bug fix:

      git checkout -b bug/bug-fix-<name>
  6. Submit a pull request to the main repository, explaining the changes you've made and providing relevant details.

  7. Participate in the code review process and address any feedback from maintainers.

  8. Once approved, your changes will be merged into the main repository.

  • Don't forget to add your name & info to the CONTRIBUTION_COUNT.md file to be recognized for your contribution!

Contribution Guidelines

  • Follow the coding standards and conventions used in the project.
  • Ensure that your contributions align with the project's goals and objectives.
  • Provide clear and descriptive commit messages and pull request descriptions.
  • Test your changes thoroughly and ensure they do not introduce regressions.
  • Be respectful and considerate of other contributors and maintainers.

We appreciate your contributions and look forward to working with you!