This repository is maintained by the Backslash Computing Society (BCS) in collaboration with the Thapar Institute of Engineering and Technology (TIET) and the LM Thapar School of Management (LMTSM). We are excited to have you on board as a contributor or user of our open-source projects. Please read this README thoroughly to understand the rules, regulations, and guidelines for working with this repository.
This repository serves as a hub for various open-source software and content developed by BCS. Our aim is to promote collaboration, learning, and innovation within the programming community. By contributing or using the contents of this repository, you agree to abide by the terms outlined in this document.
-
Fork the Repository: If you wish to contribute to this repository, start by forking it. This will create a copy of the repository under your GitHub account.
-
Clone the Repository: Clone the forked repository to your local machine using the
git clone
command. -
Make Changes: Create a new branch for your changes and make the necessary modifications.
-
Commit Changes: Commit your changes with clear and concise commit messages explaining each change's purpose.
-
Push Changes: Push your changes to your forked repository on GitHub.
-
Submit a Pull Request: If you're ready to contribute, submit a pull request from your branch to the main repository. Make sure to describe your changes and their purpose.
Rules and Regulations
-
Code of Conduct: Respect the BCS Code of Conduct and adhere to ethical behaviour while contributing or using this repository.
-
Licensing: All contributions must be made under the terms of the BCS, TIET, and LMTSM License Agreement.
-
Quality Standards: Maintain high-quality coding standards. Ensure your code is readable, well-documented, and follows any specific guidelines provided within the project's folders.
-
Issues and Discussions: Use the GitHub issues section for raising questions, reporting bugs, or suggesting enhancements.
-
Collaboration: Collaborate respectfully with fellow contributors. Avoid disrespectful language, personal attacks, or discrimination.
-
Versioning: Follow semantic versioning (SemVer) when releasing new versions of software. Increment version numbers appropriately in accordance with the project's guidelines.
-
Documentation: Provide clear and concise documentation for new features, enhancements, and bug fixes.
-
Testing: Whenever possible, include unit tests with your code contributions to ensure stability and prevent regressions.
Important Notes
-
Attempting to disrupt or damage the BCS website, repository, or services through malicious actions such as DDOS attacks is strictly prohibited and will result in severe actions.
-
Violating the rules and regulations outlined here or in the BCS, TIET, and LMTSM License Agreement may lead to disciplinary actions.
Contact
For inquiries or clarifications, please contact General Secretary Naman Babbar [[email protected]] or Tech Head Vanshaj Raghuvanshi.
Thank you for being a part of the BCS community! Your contributions and collaboration are highly valued.
Last Updated: [12 Aug 2023]