Skip to content

Latest commit

 

History

History
205 lines (134 loc) · 7.09 KB

contributing.md

File metadata and controls

205 lines (134 loc) · 7.09 KB
Raw

Contributors Guide⚡

Welcome to our open-source project! Make sure to star this repository

We appreciate your interest in contributing.😊

This guide will help you get started with the project and make your first contribution.

Join the discord link for more information related to this repository:

Discord


Project Structure 📂

PATHSPHERE/
├── .github/                # GitHub-specific files (e.g., workflows)
├── components/             # Reusable UI components
├── images/                 # Image assets for the project
├── pages/                  # HTML or main pages of the application
├── scripts/                # JavaScript files or other scripts
├── styles/                 # CSS or styling files
├── .hintrc                 # Linter configuration file
├── CODE_OF_CONDUCT.md
├── contributing.md         # Instructions For The Contribution
├── index.html              # Main entry HTML file
├── LICENSE
├── package-lock.json       # Lock file for npm dependencies
└── README.md               # Project overview and instructions

Creating first Pull Request 🌟

  1. Star this repository Click on the top right corner marked as Stars at last.

  2. Fork this repository Click on the top right corner marked as Fork at second last.

  3. Clone the forked repository

git clone https://github.com/<your-github-username>/Pathsphere.git
  1. Navigate to the project directory
cd Pathsphere
  1. Create a new branch
git checkout -b <your_branch_name>
  1. To make changes
git add .
  1. Now to commit
git commit -m "added readme 

Co-authored-by: your github username <your email related to github> 
Co-authored-by: aditya-bhaumik <[email protected]>"
  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 repository yet, you can do so by clicking on the "File" menu and selecting "Clone Repository."
    • Choose the repository from the list of repositories on GitHub and clone it to your local machine.

  3. 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.

  4. Make Changes: Make your changes to the code or files in the repository using your preferred code editor.

  5. 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.

  6. 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.

  7. Create a Pull Request:

    • Go to the GitHub website and navigate to your fork of the repository.
    • You should see a button to "Compare & pull request" between your fork and the original repository. Click on it.

  8. 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.

  9. 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 repository.


Pull Requests Review Criteria 🧲

  1. Please fill the PR Template properly while making a Pull Request.
  2. Never commit in the main branch.
  3. Your work must be original, written by you not copied from other resources.
  4. You must comment on your code where necessary.

Issues Report Process 📌

  1. Go to the project's issues :- Issues
  2. Give proper description for the issues.
  3. Don't spam to get the assignment of the issue 😀.
  4. Wait for till someone is looking into it !.
  5. Start working on issue only after you got assigned that issue 🚀.

Communication and Support 💬

  • Admin :- Aditya Bhaumik
  • Join the project's communication channels to interact with other contributors and seek assistance.
  • If you have any questions or need help, don't hesitate to ask in the project's communication channels or comment on the relevant issue.

Code of Conduct 😇

  • Please follow our project's code of conduct while contributing.

  • Treat all contributors and users with respect and create a positive and inclusive environment for everyone.


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.

License 📄

The project is licensed under MIT. Make sure to review and comply with the license terms.
We hope this guide helps you get started with contributing to our open-source project. Thank you for your contribution!


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! 🚀