Clone the repository
git clone https://github.com/swahilipothub-dev/swahilipot-website.git
Install the dependencies
npm install
Run the development server
npm run dev
-
Branching Strategy: All Pull Requests (PRs) should be created and submitted to the
main-dev-branch
branch. -
Fork the Repository: If you wish to contribute, start by forking the repository to your personal GitHub account.
-
Clone the Repository: Clone your forked repository to your local development environment.
-
Create a New Branch: Before making any changes, create a new branch in your local repository. Use a descriptive name that reflects the purpose of your changes.
git checkout -b your-branch-name
-
Make Changes: Make the necessary changes to the code, add new features, or fix issues.
-
Commit Changes: Commit your changes to your branch and provide a meaningful commit message.
git commit -m "Your informative commit message"
-
Push Changes: Push your branch to your GitHub repository.
git push origin your-branch-name
-
Create a Pull Request: Go to the main repository at swahilipot-website and create a Pull Request from your branch to the
main-development
branch. -
PR Review: Your PR will be reviewed by the repository maintainers. Be prepared to make any necessary updates based on their feedback.
-
Merge and Cleanup: Once your PR is approved, it will be merged into the
main-development
branch. You can delete your branch if it's no longer needed. -
Stay Updated: To stay informed about the project's progress, follow the repository and consider participating in discussions on issues or PRs.
Remember to follow coding conventions, include tests where applicable, and provide clear and concise documentation for your changes. Thank you for contributing to the swahilipot-website repository!