From 58c4e4d31f07e522c96aec92fab7ba2255b028f2 Mon Sep 17 00:00:00 2001 From: samet Date: Fri, 2 Feb 2024 14:18:15 +0300 Subject: [PATCH] Create CONTRIBUTING.md --- CONTRIBUTING.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..376a057 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,25 @@ + # Contribution Guidelines + +Hello! Thank you for considering contributing to our project. Below, you'll find some guidelines to help you contribute to the project. + +## How Can I Contribute? + +1. Fork the project. +2. Create a local copy: `git clone https://github.com/sametcn99/github-profile-viewer.git` +3. Create a new branch: `git checkout -b new-feature` +4. Make your changes and commit: `git commit -m "Added new feature"` +5. Push your branch to your fork: `git push origin new-feature` +6. Create a Pull Request (PR). + +## Pull Request (PR) Rules + +- Please provide a descriptive title and description. +- Make sure to update your codebase to the latest version before making any changes. +- Ensure your code follows the project's coding standards. +- When adding new features or fixing bugs, include appropriate tests or update existing ones. + +## Have Questions? + +If you have any questions or encounter issues, please open an [issue](https://github.com/sametcn99/github-profile-viewer/issues) or contact us [via email](mailto:sametcn99@gmail.com). + +Thank you!