african-states-and-tribes 1.1.1 → 1.1.3

package/.github/CONTRIBUTING.md

@@ -0,0 +1,57 @@
+# Contributing to African States and Tribes
+
+:+1: :tada: First off, thanks for taking the time to contribute! :tada: :+1:
+
+The following is a set of guidelines for contributing to the **African States and Tribes** project. These are mostly guidelines, not strict rules—use your best judgment, and feel free to propose changes via a pull request.
+
+---
+
+## How Can I Contribute?
+
+### 🛠 Fixing Data Yourself
+
+If you've spotted incorrect or outdated data, feel free to correct it and raise a pull request.
+
+---
+
+### 🌍 Contributing to the Tribes Database
+
+- The African tribes database is located in the `src/data/africa/tribes` folder.
+- Each file in this folder represents a single country and is named using the [ISO 3166-1 alpha-2 code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
+- Refer to the `README.md` for details on the structure and meaning of the properties used in the tribes files.
+- You may suggest updates or improvements as needed.
+- If you're adding new data, including a reference or source will increase the chances of your pull request being accepted.
+
+---
+
+### 🗺 Contributing to the African Countries Database
+
+- The list of African countries can be found in the `src/data/africa/countries.json` file.
+- You may suggest updates or improvements to this file as needed.
+
+---
+
+### ✨ Suggesting or Implementing New Features
+
+- New features can be implemented in the `src/index.ts` file.
+- All new feature suggestions will be reviewed to ensure they align with the project’s goals.
+
+---
+
+
+
+
+## 📋 How to Contribute via Pull Request
+
+1. **Fork** the repository to your own GitHub account.
+2. **Clone** your forked repo locally:
+   ```bash
+   git clone https://github.com/your-username/african-states-and-tribes.git
+   cd african-states-and-tribes
+3. git checkout -b your-branch-name
+4. git commit -m "Short description of your change"
+5. git push origin your-branch-name
+6. Open a Pull Request from your branch to the main branch of the original repo.
+
+
+Thank you for helping make this project better! Happy contributing!

package/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,33 @@
+# Pull Request
+
+## Description
+
+Please include a summary of the changes and the related issue(s). Explain the motivation behind this PR and any context that might be useful.
+
+Fixes # (if applicable)
+
+## Type of Change
+
+- [ ] Bug fix (non-breaking change that fixes an issue)
+- [ ] New feature (non-breaking change that adds functionality)
+- [ ] Data update (new or updated tribe or country data)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] Documentation update
+
+## Checklist
+
+- [ ] My code follows the style guidelines of this project
+- [ ] I have performed a self-review of my changes
+- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] I have added or updated relevant documentation
+- [ ] My changes generate no new warnings or errors
+- [ ] I have added tests that prove my fix is effective or that my feature works (if applicable)
+- [ ] New and existing unit tests pass locally with my changes
+
+## Screenshots / Data Samples (if applicable)
+
+Include any visuals or JSON snippets that help reviewers understand your changes.
+
+## Additional Notes
+
+Add any other relevant information, such as external references, related PRs, or anything you'd like the maintainers to know.

package/README.md

@@ -3,7 +3,7 @@
 This project provides comprehensive insights into African countries, the origins of various tribes, and their geographic distributions. Built to celebrate and document Africa’s rich multicultural landscape, it allows users to explore the continent’s diverse cultural heritage, discovering the roots and locations of countless ethnic groups across Africa.
 
 # Install
-`npm i country-state-city`
+`npm i african-states-and-tribes`
 
 # Usage
 
@@ -16,7 +16,7 @@ This project provides comprehensive insights into African countries, the origins
   - ES5 Module usage
   
     ```js
-    const africanStates = require('cafrican-states-and-tribes')
+    const africanStates = require('african-states-and-tribes')
     ```
 
 # Docs

package/SECURITY.md

@@ -5,7 +5,8 @@
 | Version | Supported          |
 | ------- | ------------------ |
 | 1.0.0   | :white_check_mark: |
+| 1.1.0   | :white_check_mark: |
+| 1.1.1   | :white_check_mark: |
+| 1.1.2   | :white_check_mark: |
 
-:x:   
-
-## Reporting a Vulnerability
+<!-- :x:    -->

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "african-states-and-tribes",
-  "version": "1.1.1",
+  "version": "1.1.3",
   "description": "This project provides comprehensive insights into African countries, the origins of various tribes, and their geographic distributions. Built to celebrate and document Africa’s rich multicultural landscape, it allows users to explore the continent’s diverse cultural heritage, discovering the roots and locations of countless ethnic groups across Africa.",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",

package/docs/CONTRIBUTING

@@ -1 +0,0 @@
-## Contributing Guide