Merge pull request #78 from vs4vijay/implement-pr-gate

Implement PR Gate for TGramBot

.github/workflows/pr-gate.yml

@@ -0,0 +1,32 @@
+name: PR Gate Workflow
+
+on:
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  pr-gate:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: '3.8'
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install ruff pytest
+
+      - name: Lint with Ruff
+        run: ruff check .
+
+      - name: Run tests
+        run: pytest
+
+      - name: Build
+        run: echo "TODO: Add commands to build the project here"

CONTRIBUTING.md

@@ -0,0 +1,28 @@
+# Contributing to TGramBot
+
+We welcome contributions to the TGramBot project. To ensure a smooth contribution process, please follow these guidelines.
+
+## Code of Conduct
+
+This project and everyone participating in it is governed by the TGramBot Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [project email].
+
+## How to Submit a Pull Request
+
+1. Fork the repository and create your branch from `main`.
+2. If you've added code that should be tested, add tests.
+3. Ensure the test suite passes.
+4. Make sure your code lints.
+5. Issue that pull request!
+
+## Pull Request Review Process
+
+The project maintainers will review your pull request. They may request changes or provide feedback. Once approved, a maintainer will merge the pull request.
+
+## Coding Standards
+
+* Write clean, maintainable code.
+* Follow the existing coding style (e.g., indentation, comments, naming conventions).
+* Include meaningful commit messages.
+* Update the README.md with details of changes to the interface, if applicable.
+
+Thank you for contributing to TGramBot!

README.md

@@ -3,6 +3,17 @@ TGramBot
 
 A Telegram Bot Control Center to send messages to list of channels
 
+## Contribution Guidelines
+
+To contribute to this project, please follow the guidelines below:
+
+- Fork the repository and create your branch from `main`.
+- Make sure your code adheres to the coding standards and passes all the automated tests.
+- Submit a pull request (PR) with your changes.
+- Your PR will be reviewed by the maintainers, and feedback will be provided if necessary.
+- Once approved, your PR will be merged into the main branch.
+
+Please note that all contributions must pass automated tests and adhere to the coding standards set for this project.
 
 ## Pre-requisites
 
@@ -337,4 +348,4 @@ C:/Users/<USER>/AppData/Local/<APPNAME>
 
 ~/Library/Application Support/<APPNAME>
 
-```
+```