diff --git a/.markdownlint.yml b/.markdownlint.yml index ee6205f5c..b637e5b1d 100644 --- a/.markdownlint.yml +++ b/.markdownlint.yml @@ -1,3 +1,7 @@ ignore: - venv - .github + +MD013: + line_length: 500 + ignore_urls: true diff --git a/.vscode/settings.json b/.vscode/settings.json index 5a90e202f..87ad2d7d7 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -113,5 +113,14 @@ }, // Enable/disable update table of contents on save - "markdown.extension.toc.updateOnSave": false + "markdown.extension.toc.updateOnSave": false, + "cSpell.words": [ + "Versity" + ], + "githubPullRequests.ignoredPullRequestBranches": [ + "main" + ], + "[python]": { + "editor.defaultFormatter": "ms-python.black-formatter" + } } diff --git a/README.md b/README.md index e69de29bb..8605cf81e 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,5 @@ +# PyVersity + +****** + +welcome to Pyversity main repository diff --git a/collaboration/README.md b/collaboration/README.md index 20889b951..3cf130140 100644 --- a/collaboration/README.md +++ b/collaboration/README.md @@ -2,4 +2,53 @@ +## Summary + +Our group values respect, collaboration, and inclusivity by fostering a safe space, +valuing diverse perspectives, +and being punctual and prepared. We follow standardized coding practices, ensure +thorough testing, +and use pull requests for repository management. Committed to learning and growth, +we support each other, respond promptly to queries, and resolve conflicts fairly +through voting. + + +## Finalized Norms + +### Respect + +* Be respectful and considerate when providing feedback or suggestions. +* We must communicate respectfully to build trust. +* We will value each other's time by being prepared and punctual. (Waiting time +for every meeting will be 5 minutes). +* Respecting everyone’s cultural/emotional background. +* We will value each other’s diverse perspectives and create a safe, collaborative +space. + +### Standardization + +* Follow the agreed upon coding standards and guidelines (e.g., naming conventions, +indentations, comments). +* Provide descriptive commit messages summarizing the changes. +* Perform testing when applicable and document any test cases; ensure all tests pass +before creating or merging a pull request. +* Never push directly to the main branch; always create a pull request. + +### Team’s Learning + +* Group members must think about the whole team’s improvement and practice good +leadership. +* We will actively assist and support each other to overcome challenges and +achieve success together. + +### Availability + +* Respond to queries or comments within 24-48 hours whenever possible. +* Every member should answer questions of the member asked on Slack or +WhatsApp if they have the answer and do not leave it for others. + +### Conflict resolution + +* Every member will have equal rights. If there is any conflict, it should be +resolved within the group through voting. diff --git a/collaboration/communication.md b/collaboration/communication.md index 484652e0f..85fa6acac 100644 --- a/collaboration/communication.md +++ b/collaboration/communication.md @@ -14,16 +14,26 @@ ______________________________________________________________________ ## Communication Schedule | Day | How | The topic of discussion | | --- | :-: | ----------------------- | -| | | | +| 21st Dec | Zoom | How to proceed with the group project? | +| 25th Dec | Zoom | Progress and Discussions on Solutions | +| 7th Jan | Zoom | Finalization | +| 8th Jan | Zoom | Merging | ## Communication Channels -how often will we get in touch on each channel, and what we will discuss there: +We shall have weekly/bi-weekly meetings on slcka/zoom to discuss any issues and progress. - **Issues**: + + + + - **Pull Requests**: -- **Slack/Discord**: -- **Video Calls**: + + + + + ______________________________________________________________________ @@ -33,15 +43,21 @@ ______________________________________________________________________ | Day | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday | Sunday | | ------ | :----: | :-----: | :-------: | :------: | :----: | :------: | :----: | -| _name_ | | | | | | | | +| Muqaddas | No | No | No | No | Yes | No | Yes | +| Nilofar | No | Yes | No | No | Yes | No | Yes | +| Shagun | No | No | No | No | Yes | No | Yes | +| Anik | No | No | No | No | Yes | No | Yes | +| Momtaz | No | No | No | No | Yes | No | Yes | +| M. Ahmed | No | No | No | No | Yes | No | Yes | ### How many hours everyone has per day -- name: _5h_; -- name: _6h_; -- name: _5h_; -- name: _4h_; -- name: _3h_; +- Muqaddas: _1.5h_; +- Shagun: _2h_; +- Nilofar: _2h_; +- Anik: _2h_; +- M. Ahmed: _2h_; +- Momtaz: _2h_; ## Asking for Help diff --git a/collaboration/constraints.md b/collaboration/constraints.md index 24079505c..4921eb646 100644 --- a/collaboration/constraints.md +++ b/collaboration/constraints.md @@ -6,6 +6,8 @@ Some boundaries around our project. ## External +The project must be completed by 8th Jan 2025. +