Skip to content

CONTRIBUTING.MD

Latest commit

 

History

History
73 lines (48 loc) · 1.97 KB

CONTRIBUTING.MD

File metadata and controls

73 lines (48 loc) · 1.97 KB

Contributing to Coptic Scribe

Thank you for considering contributing to Coptic Scribe!
This guide will help you set up the project locally and submit improvements.

🛠️ Local Setup

Each part of Coptic Scribe is hosted in a separate repository:

Component Repository
Frontend coptic-scribe-frontend
Dictionary Backend coptic-scribe-dictionary-backend
User API Backend coptic-scribe-user-backend

To set up locally:

  1. Clone the repositories:
git clone https://github.com/haddad-github/coptic-scribe-frontend.git
git clone https://github.com/haddad-github/coptic-scribe-dictionary-backend.git
git clone https://github.com/haddad-github/coptic-scribe-user-backend.git
  1. Follow the setup instructions in each repo’s README.md.

✨ How to Contribute

  1. Fork the repository you want to contribute to.
  2. Clone your fork locally.
  3. Create a new branch for your feature or fix:
git checkout -b feature/your-feature-name
  1. Make your changes.
  2. Test locally to ensure everything works.
  3. Commit and push your changes:
git add .
git commit -m "Add: short description of what you changed"
git push origin feature/your-feature-name
  1. Open a Pull Request (PR) on GitHub.

📏 Guidelines

  • Follow the coding style of the repo you’re contributing to.
  • Use clear and descriptive commit messages.
  • For large features or breaking changes, open an issue first.
  • Always test your code before submitting a PR.

📜 License

By contributing, you agree that your code will be licensed under the MIT License.

✍️ Thank You!

Your contributions make Coptic Scribe better for everyone 🙏