Skip to content

Latest commit

 

History

History
65 lines (50 loc) · 4.15 KB

GUIDELINES.md

File metadata and controls

65 lines (50 loc) · 4.15 KB
Raw

🔑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, but it needs to be verified and labelled by the maintainer. 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 the maintainer.
  13. It might take some time 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!.

🧲Pull Requests Review Criteria

  1. Please fill all the details properly while making a Pull Request.
  2. You must add your script into the respective folders.
  3. Your work must be original, written by you not copied from other resources.
  4. You must comment on your code or script where necessary.
  5. Follow the proper style guides for your work.
  6. For any queries or discussions, please feel free to drop a message.

📍Other points to remember while submitting your work:

We want your work to be readable by others; therefore, we encourage you to note the following:

  • Folder names should not have spaces and if space is needed it should follow snake_case.
  • File names for Components should be same as the component name and should follow PascalCase.
  • Use seperate file for each individual React component.
  • File extension for Components should be .jsx and other javascript files .js.
  • Please avoid creating new directories if at all possible. Try to fit your work into the existing directories.
  • The [README.md] file should be concise and clear about what the script is about and what it does.
  • It should be documented briefly enough to let readers understand.
  • If you have modified/added code work, make sure that code works before submitting.
  • If you have modified/added documentation work, ensure your language is concise and contains no grammar errors.
  • Follow the project structure.
🤔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: