Skip to content

Latest commit

 

History

History
261 lines (169 loc) · 10.3 KB

CONTRIBUTING.md

File metadata and controls

261 lines (169 loc) · 10.3 KB
Raw

Gityzer Contributing Guidelines 🎯

Thank you for taking the time to contribute to Gityzer. Your help is essential for keeping it great.

Please take a moment to read the following guidelines before contributing:

IMPORTANT ⚠️

Pull Requests having no issue associated with them will not be accepted. Firstly get an issue assigned, whether it's already opened or raised by you, and then create a Pull Request.

An automated process has been implemented to ensure the timely management of Pull Requests (PRs) on this platform.

PRs that have been open for a duration exceeding 45 days will be automatically closed, so please plan accordingly.


Code of Conduct 📃

Please read and follow our Code of Conduct


Star our Repository ⭐

Stars Forks Issues PRs Open PRs Closed


Prerequisites 📋

  • Open Source Etiquette: If you've never contributed to an open source project before, have a read of Basic etiquette for open source projects.

  • Basic familiarity with Git and GitHub: If you are also new to these tools, visit GitHub for complete beginners for a comprehensive introduction to them.


Need Help With The Basics? 🤔

If you're new to Git and GitHub, no worries! Here are some useful resources:


How to Contribute 🌐

To get started, look at the existing Create a new issue!


Setup guidelines 🪜

Note

This is Next.js project. You must have installed Node.js on your local macahine. If you don't have it installed yet,
you can download it from here.


First Pull Request ✨

  1. Fork the repository

  2. Clone the forked repository

git clone https://github.com/<your-github-username>/Gityzer.git
  1. Navigate to the project directory
cd Gityzer
  1. Create a new branch
git checkout -b <your_branch_name>
  1. To make changes
git add .
  1. Now to commit
git commit -m "add comment according to your changes or addition of features inside this"
  1. Push your local commits to the remote repository
git push -u origin <your_branch_name>

  1. Create a Pull Request

  2. Congratulations! 🎉 you've made your contribution

Alternatively, contribute using GitHub Desktop 🖥️

  1. Open GitHub Desktop: Launch GitHub Desktop and log in to your GitHub account if you haven't already.

  2. Clone the Repository:

  • If you haven't cloned the project repository yet, you can do so by clicking on the "File" menu and selecting "Clone Repository."
  • Choose the project repository from the list of repositories on GitHub and clone it to your local machine.
  1. Switch to the Correct Branch:
  • Ensure you are on the branch that you want to submit a pull request for.
  • If you need to switch branches, you can do so by clicking on the "Current Branch" dropdown menu and selecting the desired branch.
  1. Make Changes:
  • Make your changes to the code or files in the repository using your preferred code editor.
  1. Commit Changes:
  • In GitHub Desktop, you'll see a list of the files you've changed. Check the box next to each file you want to include in the commit.
  • Enter a summary and description for your changes in the "Summary" and "Description" fields, respectively. Click the "Commit to " button to commit your changes to the local branch.
  1. Push Changes to GitHub:
  • After committing your changes, click the "Push origin" button in the top right corner of GitHub Desktop to push your changes to your forked repository on GitHub.
  1. Create a Pull Request:
  • Go to the GitHub website and navigate to your fork of the project repository.
  • You should see a button to "Compare & pull request" between your fork and the original repository. Click on it.
  1. Review and Submit:
  • On the pull request page, review your changes and add any additional information, such as a title and description, that you want to include with your pull request.
  • Once you're satisfied, click the "Create pull request" button to submit your pull request.
  1. Wait for Review: Your pull request will now be available for review by the project maintainers. They may provide feedback or ask for changes before merging your pull request into the main branch of the project repository.

To Install dependencies 👾

  • Installation:

    npm install

  • Run the Deployment Server:

    npm run dev

  • Open http://localhost:3000 with your browser to see the result.


Note

All images must be in webp or avif format, not png, jpeg, jpg, or others. This practice applies to the entire repository.

Use freeconvert.com to convert images to the required webp or avif formats.


For Help And Support 💬


Guidelines for Good Commit Messages ✅

We follow a standardized commit message format using Commitlint to ensure consistency and clarity in our commit history. Each commit message should adhere to the following guidelines:

  1. Be Concise and Descriptive: Summarize the change in a way that’s easy to understand at a glance.
  2. Use the Imperative Mood: Write as if giving a command (e.g., Add, Fix, Update), which is a convention in many projects.
  3. Include Context: Provide context or reason for the change if it’s not immediately obvious from the summary.
  4. Reference Issues and Pull Requests: Include issue numbers or PR references if the commit addresses them.
  5. Issue reference (Optional): Include the issue number associated with the commit (e.g., #123).

Examples of Invalid Commit Messages ❌

  • Added new stuff
  • Fixed a bug
  • Updated code
  • auth feature update
  • chore: fixed some stuff

Commit Example with Commitlint

git commit -m "feat(auth): Implement user signup process (#789)"

Good Coding Practices 🧑‍💻

  1. Follow the Project's Code Style

    • Maintain consistency with the existing code style (indentation, spacing, comments).
    • Use meaningful and descriptive names for variables, functions, and classes.
    • Keep functions short and focused on a single task.
    • Avoid hardcoding values; instead, use constants or configuration files when possible.

  2. Write Clear and Concise Comments

    • Use comments to explain why you did something, not just what you did.
    • Avoid unnecessary comments that state the obvious.
    • Document complex logic and functions with brief explanations to help others understand your thought -process.

  3. Keep Code DRY (Don't Repeat Yourself)

    • Avoid duplicating code. Reuse functions, methods, and components whenever possible.
    • If you find yourself copying and pasting code, consider creating a new function or component.

  4. Write Tests

    • Write unit tests for your functions and components.
    • Ensure your tests cover both expected outcomes and edge cases.
    • Run tests locally before making a pull request to make sure your changes don’t introduce new bugs.

  5. Code Reviews and Feedback

    • Be open to receiving constructive feedback from other contributors.
    • Conduct code reviews for others and provide meaningful suggestions to improve the code.
    • Always refactor your code based on feedback to meet the project's standards.

Pull Request Process 🚀

When submitting a pull request, please adhere to the following:

  1. Self-review your code before submission. 😀
  2. Include a detailed description of the functionality you’ve added or modified.
  3. Comment your code, especially in complex sections, to aid understanding.
  4. Add relevant screenshots to assist in the review process.
  5. Submit your PR using the provided template and hang tight; we'll review it as soon as possible! 🚀

Issue Report Process 📌

To report an issue, follow these steps:

  1. Navigate to the project's issues section :- Issues
  2. Please kindly choose the appropriate template according to your issue.
  3. Provide a clear and concise description of the issue.
  4. Wait until someone looks into your report.
  5. Begin working on the issue only after you have been assigned to it. 🚀

Thank you for contributing 💗

We truly appreciate your time and effort to help improve our project. Feel free to reach out if you have any questions or need guidance. Happy coding! 🚀