The proposal should be in Document format ( .docx , .md , .pptx ) , and the number of pages should not exceed 10 pages. The content should be brief , but at the same time , should also cover all the vital points.
Proposals should be submitted Through 📧 [email protected]
Every proposal must follow the structure as mentioned below :
- Title
- Origin of the Idea
- POC (Proof of Concept)
- One Liner
- Detailed Description
- Screenshots , Demo in form of Media ( optional )
- Assurance of Completion
- ETA of completion of Project
Every project must follow the CODE OF CONDUCT along with the above format mentioned. The project must not be an already existing project in the Organization. People who are interested in adding more features to existing projects can contribute to the same.
The Project MUST CONTAIN A README.MD file with a clear and concise information about how to use the project , and a Documentation for the project covering all the objects , classes and data members which are to be informed. Projects with a illegible README.MD or documentation will be REJECTED irrespective of the Idea and Importance of the Project.
Being an Open-Source Organization , the firm accepts only public projects. No personal projects such as Portfolio , or Projects which are at elementary level, will not be accepted.
Proposals with less number of commits having larger diffs will have more chances of acceptance then the ones with more number of commits having smaller diffs, since commiting very small changes (Except Issues) and Commit spams will usually be discouraged and will show up improper maintainence of source code.
Contributions to existing repositories are done by forking the repositories, commiting the changes and creating a Pull Request (PR). Accepting pull requests are completely controled by the respective Repository Owners and not the Organization .
Guides on how to create a Pull Request
The Pull Request must contain the following contents
- Title : Should be small , yet descriptive Title
- Description : Should contain a detailed description.
- Media : Screenshots or Demo Videos
Issues are raised when other developers find any error(s) in the source code, since raising bugs which the developer didnt find, by other developers, makes life easier in creating a stable project. Issues can be raised by first acknowledging them in the Issues panel of the repository. Once the developer reviews it, he may solve / he may assign it to other devs who requested for the same. You can also request an assignment of an issue to yourself, by mentioning the same.
Docs on Issues
Issues must be structured and crystal clean , and must have the following contents
- Error Description : Describe the error with the source code snippet and suggest the solution too, if any
- How to Reproduce * : Mention how to reproduce the code so that devs can generate the error for further development
- Anything Else : Contents to add as extras