Skip to content

Latest commit

 

History

History
60 lines (44 loc) · 3.8 KB

CONTRIBUTING.md

File metadata and controls

60 lines (44 loc) · 3.8 KB

Contributing Guidelines for the InternApp GitHub Repositories

Thank you for your interest in contributing to the InternApp GitHub repositories! We welcome your contributions and appreciate your efforts to help us create a collaborative coding community. To ensure a smooth and effective collaboration, please follow these guidelines when making contributions.

Table of Contents

  1. How to Contribute
  2. Reporting Issues
  3. Submitting Pull Requests
  4. Coding Guidelines
  5. Commit Message Guidelines
  6. Code of Conduct

How to Contribute

To contribute to the InternApp GitHub repositories, please follow these steps:

  1. Fork the repository to your GitHub account.
  2. Create a new branch from the main branch for your contributions.
  3. Make the necessary changes or additions in your branch.
  4. Test your changes locally to ensure they function as expected.
  5. Commit your changes with clear and descriptive commit messages.
  6. Push your branch to your forked repository.
  7. Submit a pull request to the main repository, clearly describing the purpose and scope of your contribution.

Our repository maintainers will review your pull request and provide feedback or suggestions if necessary. We appreciate your patience during the review process.

Reporting Issues

If you encounter any issues or have suggestions for improvements, please submit an issue using the issue tracker in the repository. When reporting an issue, provide a clear and detailed description, including steps to reproduce (if applicable) and any relevant error messages or screenshots. This will help us better understand and address the problem.

Submitting Pull Requests

When submitting a pull request, please ensure that:

  • Your code follows the coding guidelines specified in the Coding Guidelines section.
  • You have tested your changes locally to verify their functionality.
  • Your commit messages follow the guidelines outlined in the Commit Message Guidelines section.
  • You provide a clear and concise description of your pull request, explaining its purpose and any additional information that may be relevant to the reviewers.

Coding Guidelines

To maintain a consistent codebase and ensure readability, we follow these coding guidelines:

  • Use clear and descriptive names for variables, functions, and classes.
  • Write self-explanatory and properly documented code. Add comments where necessary to improve code understanding.
  • Follow the appropriate coding style for the programming language used in the repository.
  • Format your code consistently, paying attention to indentation, spacing, and line length.
  • Write unit tests for new features or modifications to ensure code quality.

Please familiarize yourself with the existing codebase and adhere to the established coding style to ensure code consistency.

Commit Message Guidelines

When writing commit messages, please follow these guidelines:

  • Write clear and descriptive commit messages that summarize the purpose of the commit concisely.
  • Use the present tense and imperative mood in commit messages (e.g., "Add feature" instead of "Added feature").
  • Reference relevant issues or pull requests using the appropriate keywords (e.g., "Fixes #IssueNumber" or "Resolves #PRNumber").

Following these guidelines will help us maintain a clear and well-documented history of the repository.

Code of Conduct

Please review and adhere to our Code of Conduct. We expect all contributors to uphold the standards and principles outlined in the code of conduct to ensure a respectful and inclusive community.

Thank you for contributing to the InternApp GitHub repositories! Your involvement is highly appreciated.