Skip to content

Latest commit

 

History

History
40 lines (25 loc) · 2.63 KB

CONTRIBUTING.md

File metadata and controls

40 lines (25 loc) · 2.63 KB

Contributing to GitHub-Profile-Viewer

We're excited you're interested in contributing to GitHub-Profile-Viewer! This document outlines the steps and guidelines for contributing to the project.

Getting Started

  1. Fork the repository: Click the "Fork" button at the top of the project's homepage on GitHub. This creates a copy of the repository in your own account.
  2. Clone the forked repository: Use git clone https://github.com/ShadBalti/GitHub-Profile-Viewer.git to clone your forked repository to your local machine.
  3. Create a new branch: Create a new branch for your changes. We recommend using a descriptive branch name that reflects your contribution, like fix-readme-typo or feature-enhance-stats-page.
  4. Make your changes: Make your changes and commit them to your local branch. Please follow our coding style guidelines (link to guidelines, if applicable).
  5. Push your changes: Push your branch to your forked repository on GitHub.
  6. Open a pull request: Go to your forked repository on GitHub and open a pull request to the main branch of the original repository.
  7. Follow the conversation: We'll review your pull request and provide feedback. Address any comments or suggestions before your pull request can be merged.

Contribution Types

We welcome diverse contributions, including:

  • Bug fixes: If you find a bug, please open an issue and submit a pull request with the fix.
  • New features: We're open to new features if they align with the project's goals and are well-designed. Discuss your idea with the maintainers before starting development.
  • Documentation improvements: Feel free to improve the existing documentation, like the README or CONTRIBUTING.md.
  • Code quality improvements: We appreciate contributions that improve the code quality, such as refactoring, adding tests, and improving code coverage.

Commit Messages

Please write clear and concise commit messages that describe your changes. Follow the conventional commit message format for better readability.

Pull Request Reviews

We encourage active participation in pull request reviews. Provide constructive feedback and suggestions to help other contributors improve their work.

License

All contributions to GitHub-Profile-Viewer are subject to the [LICENSE]. By submitting a pull request, you agree to license your contribution under this license.

Questions and Feedback

We welcome your questions and feedback! Feel free to open an issue on the repository or contact the maintainers directly.

Thank you for contributing to GitHub-Profile-Viewer! We appreciate your help in making this project even better.