Merge pull request #1 from Encircle-Marketing/add-initial-documentati…

…on-and-templates

feat: add README and pull request template

profile/README.md

@@ -0,0 +1,48 @@
+# Welcome to Encircle Marketing
+
+Welcome to the GitHub organization of Encircle Marketing. We primarily work with private repositories; hence, to access 
+them, you must be added to the organization.
+
+## Team Organization
+
+We utilize GitHub teams to organize and structure our organization. Teams can be tagged within repositories for pull request reviews, ensuring a streamlined and efficient code review process.
+
+## Package Management
+
+Our organization uses the GitHub Package Registry to host all private and public packages, including Docker, npm, and Python packages.
+
+### Installing Python Packages
+
+To install our Python packages using SSH, follow these steps:
+
+1. Ensure you have set up SSH keys with your GitHub account. For more information, see [GitHub SSH Key Setup](https://docs.github.com/en/authentication/connecting-to-github-with-ssh).
+2. Use the following command to install the package:
+
+    ```sh
+    pip install git+ssh://git@github.com:encirle-marketing/[RepositoryName].git
+    ```
+
+### Installing Node Packages
+
+To install our Node packages using `.npmrc`, follow these steps:
+
+1. Create or open your `.npmrc` file in your home directory.
+
+2. Add the following lines to your `.npmrc` file:
+
+    ```plaintext
+    @EncirleMarketing:registry=https://npm.pkg.github.com
+    //npm.pkg.github.com/:_authToken=YOUR_GITHUB_TOKEN
+    ```
+
+3. Install the package using npm:
+
+    ```sh
+    npm install @EncirleMarketing/[PackageName]
+    ```
+
+## Contact
+
+If you have any questions or need further assistance, please contact the senior developer.
+
+Thank you for being a part of Encircle Marketing!

pull_request_template.md

@@ -0,0 +1,166 @@
+<!--
+     For Work In Progress Pull Requests, please use the Draft PR feature,
+     see https://github.blog/2019-02-14-introducing-draft-pull-requests/ for further details.
+
+     For a timely review/response, please avoid force-pushing additional
+     commits if your PR already received reviews or comments.
+
+     Before submitting a Pull Request, please ensure you've done the following:
+     - 👷‍♀️ Create small PRs. In most cases this will be possible.
+     - ✅ Provide tests for your changes.
+     - 📝 Use descriptive commit messages.
+     - 📗 Update any related documentation and include any relevant screenshots.
+-->
+
+## Pull Request Title
+
+<!--
+Provide a succinct and clear title for the feature, e.g., "Introduce advanced search functionality"
+Suggested format: [Type]: Brief description (e.g., 'Feature: Implement user authentication', 'Fix: Resolve login page crash')
+-->
+
+## What type of PR is this? (check all applicable)
+
+<!-- Do not delete lines in this section. Only add "x" in the appropriate boxes -->
+
+- [ ] Refactor (code restructuring without changing functionality)
+- [ ] Feature (new functionality added to the project)
+- [ ] Bug Fix (non-breaking alteration which rectifies an issue)
+- [ ] Optimization (performance or efficiency improvements)
+- [ ] Documentation Update (changes to documentation only)
+
+## Description of the PR
+
+<!--
+A brief overview of the pr being considered. Explain the functionality and its intended purpose.
+-->
+
+
+<!--
+The line below triggers an automatic summary of the changes by CodeRabbit AI. You can remove or replace it with your own summary if you prefer.
+-->
+
+@gensummary
+
+## Implementation Details
+
+<!--
+Describe your approach to implementing the feature. Include any design decisions and methods used.
+-->
+
+## Impact of the Feature
+
+<!--
+Discuss how this feature affects the existing codebase, including any potential behavioural or performance changes.
+-->
+
+## [optional] Related Tickets & Documents
+
+<!--
+For pull requests that relate to or close an issue, please include them below.
+We like to follow [GitHub's guidance on linking issues to pull requests](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue).
+
+For example, having the text: "closes #1234" would connect the current pull
+request to issue 1234 on GitHub or Jira, and when we merge the pull request,
+GitHub & Jira will automatically close the issues.
+-->
+
+- Related Issue #
+- Closes #
+
+## QA Instructions, Screenshots, Recordings
+
+<!--
+Provide the following information to assist in testing your changes:
+
+- **Test Environment Details**:
+  - Operating System(s): *e.g., Windows 10, macOS Monterey*
+  - Browser(s) and Version(s): *e.g., Chrome 95, Firefox 93*
+
+- **Steps to Reproduce**:
+  1. *Detailed step-by-step instructions to test or reproduce the changes or bug.*
+  2. *...*
+
+- **Expected Outcomes**:
+  - *Describe the expected results after performing the steps.*
+
+- **Actual Outcomes**:
+  - *If applicable, note any differences between expected and actual results.*
+
+- **Known Limitations or Edge Cases**:
+  - *Mention any specific conditions or scenarios that could affect testing.*
+
+- **Screenshots/Recordings**:
+  - *Include any relevant images or videos that illustrate the changes or issues.*
+-->
+
+### Checklist
+
+<!-- Do not delete lines in this section. Only add "x" in the appropriate boxes -->
+
+#### Basic Checklist
+
+Code Quality:
+
+<!-- Do not delete lines in this section. Only add "x" in the appropriate boxes -->
+
+- [ ] The code adheres to the project's coding and style guidelines.
+- [ ] The code adheres to industry-standard security practices.
+- [ ] I have conducted a self-analysis of my code to ascertain it meets quality benchmarks.
+- [ ] I have annotated my code, particularly in sections that might be challenging to comprehend.
+
+Testing:
+
+<!-- Do not delete lines in this section. Only add "x" in the appropriate boxes -->
+
+- [ ] I have exhaustively tested my amendments in diverse scenarios and settings (local/CI/CD).
+- [ ] I have instituted or refreshed unit and integration tests to substantiate my changes.
+- [ ] Current and emergent unit tests pass locally with my alterations.
+
+Performance and Error Handling:
+
+<!-- Do not delete lines in this section. Only add "x" in the appropriate boxes -->
+
+- [ ] I have verified that my amendments do not introduce new cautions or errors.
+- [ ] I have scrutinised and rectified any potential performance issues.
+
+Dependencies:
+
+<!-- Do not delete lines in this section. Only add "x" in the appropriate boxes -->
+
+- [ ] Any reliant alterations have been amalgamated and published in downstream modules, if applicable.
+
+#### Documentation Checklist
+
+<!-- Do not delete lines in this section. Only add "x" in the appropriate boxes -->
+
+- [ ] I have revised the documentation correspondingly, including README and docstrings.
+- [ ] The updates are clear, concise, and correct grammatically.
+- [ ] All modified documentation pages have been tested for the proper layout.
+- [ ] The documentation accurately reflects the current state of the project.
+- [ ] Technical terms and jargon are explained or linked to additional resources.
+
+#### UI changes [Optional]
+
+<!-- Do not delete lines in this section. Only add "x" in the appropriate boxes -->
+
+- [ ] Checked with [axe DevTools](https://www.deque.com/axe/) and addressed `Critical` and `Serious` issues?
+- [ ] Colour contrast tested?
+- [ ] I have documented the rationale behind the UI/UX changes.
+- [ ] User feedback, if available, has been considered and incorporated.
+
+### Added/updated tests?
+
+<!-- We encourage you to keep the code coverage percentage at 80% and above. -->
+<!-- Do not delete lines in this section. Only add "x" in the appropriate boxes -->
+
+- [ ] Yes
+- [ ] No, and this is why: _please replace this line with details on why tests have not been included_
+- [ ] I need help with writing tests
+
+<!--
+Detail the tests carried out to ensure the feature works as intended and integrates well with the existing system.
+-->
+
+## [optional] Are there any post-deployment tasks we need to perform?
+