Skip to content

Latest commit

 

History

History
71 lines (53 loc) · 2.55 KB

CONTRIBUTING.md

File metadata and controls

71 lines (53 loc) · 2.55 KB
Raw

Contribution Guidelines

Thank you for considering contributing to DEPA for Training! We appreciate your interest and welcome any help you can provide. To ensure a smooth and effective collaboration, please review the following guidelines before getting started.

Getting Started

  1. Fork the Repository:

    • Fork the DEPA for Training repository on GitHub.
    • Clone your forked repository to your local machine: 
      git clone https://github.com/your-username/depa-training.git

  2. Branching:

    • Create a new branch for your contribution: 
      git checkout -b feature/your-feature

  3. Development:

    • Make your changes and ensure that your code follows our coding standards.
    • Include relevant documentation if needed.

  4. Testing:

    • Run existing tests and/or create new ones to validate your changes.
    • Ensure that your changes do not break existing functionality.

  5. Committing:

    • Commit your changes with a clear and descriptive commit message: 
      git commit -m "Add your meaningful message here"

  6. Pushing:

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

  7. Pull Request:

    • Open a pull request on the DEPA for Training and provide a detailed description of your changes.
    • Reference any relevant issues in your pull request.

Contribution Guidelines

  1. Coding Standards:

    • Follow the existing coding style and conventions used in the project.
    • Adhere to the language-specific best practices.

  2. Documentation:

    • Include clear and concise documentation for any new features or changes.
    • Update existing documentation as needed.

  3. Testing:

    • Write tests for new functionality and ensure that existing tests pass.
    • Test your changes across different environments if applicable.

  4. Issue Tracker:

    • Check the issue tracker for open issues.
    • If you plan to work on an issue, comment on it to let others know.

  5. Be Respectful:

    • Be respectful to other contributors and maintain a positive and inclusive atmosphere.

Review Process

  1. All contributions will be reviewed by the maintainers.
  2. Feedback and discussions may occur during the review process.
  3. Once approved, your contribution will be merged into the main branch.

Thank you for contributing to DEPA Training! Your efforts help make this project better for everyone.