Contributing Guidelines
Ahoy there! Welcome to the PEC-ACM Open Source Repository. We request you to read the whole guidelines before making any pull requests. In case any doubt arises, please feel free to ask it in the Discussion tab.
Join Official ACM PEC Open-Source Slack Channel to be contribute to our Projects:
https://join.slack.com/t/acmpecopen-source/shared_invite/zt-11mvk2veo-n_ZGh1e6fzhFIKrs57EXgg
Resources for various CS fields
This repository also shares a collection of resources, contributed by the members of PEC ACM CSS as well as other tech enthusiasts of the college, for learning various fields of computer science. You can make use of these resources as a reference point for honing your technical skills.
Resources | Link to the respective folder |
---|---|
Machine Learning | ML |
Web Development | Web Dev resources |
App Development | App Dev resources |
Competitive Coding & DSA | CP DSA resources |
Git and Github | GIT |
Open-Source | Open-source |
Cyber Security | Cyber Security |
Blockchain Development | Blockchain |
Programming Languages | Languages |
PEC Courses | PEC-Courses |
Other Tech | Other Tech resources |
You wish to further enrich this collection of resources?
Well go ahead and add your own as well
- Either fill up this google form and your response will be updated by us in the repo
- OR send a PR after adding your response to the README file of the respective resource folder
Contributing
How to Contribute
There are several issues marked in the Issues section. These include the questions with appropriate labels (if you are new to contributing we recommend you filter by good-first-issue label). Clicking on an open issue will show you the problem statement. Read that carefully and code what is asked for (sometimes the expected complexity of the solution may be marked).
NOTE : If you are solving any Issue, make sure you create a new branch, mention the Issue ID in the title of your Pull request and adhere to the Code of conduct and Coding style.
-
If you are a complete beginner install the below resources:
- You would first need to install GIT
- We recommend you use VSCode for making changes. Download Link
-
Here's how you can create your first Pull Request(PR):
For Contributors
It's our pleasure that you are considering contributing to this repository. We hope that this repository can be used by learners from PEC, or anywhere in the world. Being one of the contributors, you must adhere to the following Code of Conduct:
- Please make sure that the solution you are submitting has not already been added or a PR has already been raised. You should check that before submitting your PR.
- Check the label for the Issue you are solving, for example if it's good-first-issue then add your solution file in the Good-First-Issue folder and name the file appropiately or use the title itself (Print_Subsets_of_Array.cpp)
Coding Style
- You can use any programming language you want.
- It is recommended that you use concepts of Object Oriented Programming and Functions. Their names must be intuitive and should make their purpose clear to the readers.
- Use proper naming conventions for the language you are coding in. If you're not familiar with them, here are the conventions for C++ and Python.
- Make proper use of comments/docstrings wherever necessary but do not use them for stuff too trivial.
- If you are modifying documentation/comments, make sure your language is concise.
- You can also add the algorithm explanation as a comment if you wish to.
- Use camelCase for variable and function names.
- And the most important thing: Have fun coding!