Skip to content

Latest commit

 

History

History
115 lines (82 loc) · 5.49 KB

CONTRIBUTING.md

File metadata and controls

115 lines (82 loc) · 5.49 KB

🎇Contributing Guidelines

This documentation contains a set of guidelines to help you during the contribution process.

I'm happy to welcome all the contributions from anyone willing to add new scripts to this repository. Thank you for helping out and remember, no contribution is too small.

💻Before Contributing

Welcome to MightyITExplorer/Website. Before sending your pull requests, make sure that you read the whole guidelines. If you have any doubt about the contributing guide, please feel free to reach out.

🙌Contribution

Any contribution is accepted, from fixing grammatical mistakes to implementing complex scripts. Please read this section if you are contributing your work. Create an issue of a feature you would like to add in the project and get the task assigned to you. You should give a preview whenever you raise a PR and if you raise an issue you have to explain it well

🔖Steps to Contribute

Following are the steps to guide you:

  • Step 1: Fork the repo and Go to your Git terminal and clone it on your machine. 
    git clone https://github.com/<your_github_username>/Website
  • Step 2: Add an upstream link to the main branch in your cloned repo 
    git remote add upstream https://github.com/MightyITExplorer/Website.git
  • Step 3: Keep your cloned repo up to date by pulling from upstream (this will also avoid any merge conflicts while committing new changes) 
    git pull upstream main
  • Step 4: Create your feature branch (This is a necessary step, so don't skip it) 
    git checkout -b <feature-name>
  • Step 5: Track and stage your changes. 
     # Track the changes
git status

 # Add changes to Index
git add .
  • Step 6: Commit all the changes (Write commit message as "Small Message") 
    git commit -m "Write a meaningful but small commit message"
  • Step 7: Push the changes for review 
    git push origin <branch-name>
  • Step 8: Create a PR on Github. (Don't just hit the create a pull request button, you must write a PR message to clarify why and what are you contributing)

🔨Note:

  • Do not edit/delete someone else's script in this repository. You can only insert new files/folders into this repository.
  • Give a meaningful name to whatever file or folder you are adding.

🔑Guidelines

  1. Welcome to this repository, if you are here as an open-source program participant/contributor.
  2. Participants/contributors have to comment on issues they would like to work on, and mentors or the PA will assign you.
  3. Issues will be assigned on a first-come, first-serve basis.
  4. Participants/contributors can also open their issues using issue_template, but it needs to be verified and labelled by a mentor or PA. Please discuss with the team once before opening your issues. We respect all your contributions, whether it is an Issue or a Pull Request.
  5. When you raise an issue, make sure you get it assigned to you before you start working on that project.
  6. Each participant/contributor will be assigned 1 issue (max) at a time to work.
  7. Participants are expected to follow project guidelines and coding style . Structured code is one of our top priorities.
  8. Try to explain your approach to solve any issue in the comments. This will increase the chances of you being assigned.
  9. Don't create issues that are already listed.
  10. Please don't pick up an issue already assigned to someone else. Work on the issues after it gets assigned to you.
  11. Make sure you discuss issues before working on the issue.
  12. Pull requests will be merged after being reviewed by a mentor or PA.
  13. It might take a day or two to review your pull request. Please have patience and be nice.
  14. Always create a pull request from a branch other than main.
  15. Participants/contributors have to complete issues before the decided Deadline. If you fail to make a PR within the deadline, then the issue will be assigned to another person in the queue.
  16. While making PRs, don't forget to add a description of your work.
  17. Include issue number (Fixes: issue number) in your commit message while creating a pull request.
  18. Make sure your solution to any issue is better in terms of performance and other parameters in comparison to the previous work.
  19. We all are here to learn. You are allowed to make mistakes. That's how you learn, right!.

📝 Project Structure for Issues :

📝 Project Structure for All Kind of Issues and PR's :

Create an issue with your idea, approach, your expected outcome and why it's useful to be necessary to be included in this project. For PR, include issue number along with PR template, it's details and compiled output screenshot

🤔Need more help?

You can refer to the following articles on the basics of Git and Github and also contact me, in case you are stuck:

🎉 🎊 😃 Happy Contributing 😃 🎊 🎉