Skip to content

Latest commit

 

History

History
56 lines (37 loc) · 2.45 KB

CONTRIBUTING.md

File metadata and controls

56 lines (37 loc) · 2.45 KB

Contributing to GitHub Desktop Starter Showcase

Thank you for considering contributing to the GitHub Desktop Starter Showcase repository! Your contributions help make this resource more valuable for others. Here are some guidelines to help you get started.

Table of Contents

Reporting Issues

If you discover a bug, have a feature request, or would like to suggest an improvement, please create an issue. Before opening a new issue, please check the existing issues to avoid duplicates.

  1. Use a clear and descriptive title.
  2. Provide a detailed description, including steps to reproduce for bugs.
  3. Attach relevant screenshots, if applicable.
  4. Add appropriate labels to categorize the issue.

Making Contributions

We welcome contributions in the form of bug fixes, feature additions, improvements to documentation, and more. To contribute:

  1. Fork the repository to your GitHub account.
  2. Create a new branch for your contribution: git checkout -b your-branch-name.
  3. Make your changes and commit them with descriptive messages.
  4. Push your changes to your forked repository: git push origin your-branch-name.

Pull Request Process

When you are ready to submit your changes, follow these steps:

  1. Open a pull request against the main branch of this repository.
  2. Use a clear and descriptive title for your pull request.
  3. Include a summary of your changes and their purpose.
  4. Reference related issues by mentioning their numbers, e.g., "Fixes #123".
  5. Ensure that your branch is up to date with the latest changes from the main branch.

Coding Guidelines

  • Follow consistent code formatting to ensure readability.
  • Include comments to explain complex or non-obvious sections of your code.
  • Use meaningful variable and function names that reflect their purpose.
  • Test your changes thoroughly before submitting a pull request.

Feedback

We value your feedback on the contribution process and this repository's content. If you have any suggestions or improvements for these guidelines or any other aspect of the repository, please open an issue to let us know.

Thank you for your interest in contributing to the GitHub Desktop Starter Showcase!

By contributing to this repository, you agree to adhere to the Code of Conduct.