Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
59 lines (42 loc) · 2.41 KB

CONTRIBUTING.md

File metadata and controls

59 lines (42 loc) · 2.41 KB

Contributing Guidelines

Thank you for your interest in contributing to our project! We appreciate your help in making this project better. Please follow the guidelines below to ensure a smooth contribution process.

How to Contribute

  1. Fork the Repository

    • Start by forking the repository to your own GitHub account.

  2. Clone Your Fork

    • Clone the forked repository to your local machine: 
      git clone https://github.com/CreativeAcer/OffboardingManager.git

  3. Create a Branch

    • Before making any changes, create a new branch from the development branch. Use a descriptive name for your branch that reflects the feature or functionality you are adding or modifying: 
      git checkout development
git checkout -b feature/contributing-functionalityname

  4. Make Your Changes

    • Implement your feature or fix any issues. Be sure to write clear and concise commit messages.

  5. Test Your Changes

    • Thoroughly test your changes to ensure everything works as expected.

  6. Commit Your Changes

    • Once you’re satisfied with your changes, commit them: 
      git add .
git commit -m "Add feature: contributing functionality name"

  7. Push to Your Fork

    • Push your changes to your forked repository: 
      git push origin feature/contributing-functionalityname

  8. Create a Pull Request

    • Go to the original repository and click on the “Pull Requests” tab. Click on “New Pull Request” and select your branch. Provide a clear description of your changes and submit the pull request.

Guidelines for Contributions

  • Code Quality: Please ensure your code adheres to the project's coding standards. Consider adding comments where necessary.
  • Documentation: If your changes affect any existing documentation or require new documentation, please update it accordingly.
  • Issue Tracking: If you are fixing a bug or implementing a new feature, consider referencing the relevant issue in your pull request.

Code of Conduct

We are committed to creating a welcoming environment for everyone. Please adhere to our Code of Conduct while contributing.

Questions?

If you have any questions about the contribution process, feel free to open an issue or reach out to the maintainers.

Thank you for contributing!