From c5a401957e9f020c9d461ade7e21c06e2b018c3b Mon Sep 17 00:00:00 2001 From: Haimantika Mitra Date: Mon, 8 Jan 2024 22:59:27 +0530 Subject: [PATCH 1/3] Added Conributing Guide --- CONTRIBUTING.md | 81 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 81 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..c9977d81d --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,81 @@ +# Contributing + +We would ❤️ you to contribute to Headless Hashnode Starter kit and help make it better! We want contributing to Hashnode to be fun, enjoyable, and educational for anyone and everyone. All contributions are welcome, including issues, integrations, updates and tweaks. + +## How to Start? + +If you are worried or don’t know where to start, you can checkout open issues or add new issues and comment your interest and a maintainer can guide you. Alternatively, you can send your questions to anyone from the [Hashnode team on Discord](https://hshno.de/discord). + +## Code of Conduct + +Help us keep Appwrite open and inclusive. Please read and follow our [Code of Conduct](https://github.com/appwrite/.github/blob/main/CODE_OF_CONDUCT.md). + +## Submit a Pull Request 🚀 + +Branch naming convention is as following + +`TYPE-DESCRIPTION` + +example: + +``` +feat-adds-profile-section +``` + +When `TYPE` can be: + +- **feat** - a new feature +- **fix** - a bug fix +- **refactor** - code change that neither fixes a bug nor adds a feature + +**All PRs must include a commit message with the description of the changes made!** + +For the initial start, fork the project and use git clone command to download the repository to your computer. A standard procedure for working on an issue would be to: + +1. `git pull`, before creating a new branch, pull the changes from upstream. Your master needs to be up to date. + +``` +$ git pull +``` + +2. Create a new branch from `master` like: `feat-adds-profile-section`.
+ +``` +$ git checkout -b [name_of_your_new_branch] +``` + +3. Work - commit - repeat (make sure you're on the correct branch!) + +4. Push changes to GitHub. + +``` +$ git push origin [name_of_your_new_branch] +``` + +5. Submit your changes for review + If you go to your repository on GitHub, you'll see a `Compare & pull request` button. Click on that button. +6. Start a Pull Request + Now submit the pull request and click on `Create pull request`. +7. Get a code review approval/reject. +8. After approval, merge your PR. +9. GitHub will automatically delete the branch after the merge is done. (they can still be restored). + +## Setup From Source + +To set up a working **development environment**, just fork the project git repository and install the backend and frontend dependencies using the proper package manager and create run the docker-compose stack. + +> If you just want to get started with Headless Hashnode for day-to-day use and not as a contributor, you can refer to the [guide](https://hashnode.com/headless) or the [README](README.md) file. + +```bash +git clone git@github.com:[YOUR_FORK_HERE]/starter-kit.git + +cd starter-kit + +pnpm install + +npm run dev +``` +## Resources +To stay updated with latest updates of Hashnode, you can follow: +- [Changelog](https://hashnode.com/changelog) +- [Hashnode Discord Server](https://hshno.de/discord) From 34977f5f3f9d22dc96680e2e19c405166574bb32 Mon Sep 17 00:00:00 2001 From: Haimantika Mitra Date: Mon, 8 Jan 2024 23:07:00 +0530 Subject: [PATCH 2/3] Made some changes --- CONTRIBUTING.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c9977d81d..5c2c988b1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,10 +6,6 @@ We would ❤️ you to contribute to Headless Hashnode Starter kit and help make If you are worried or don’t know where to start, you can checkout open issues or add new issues and comment your interest and a maintainer can guide you. Alternatively, you can send your questions to anyone from the [Hashnode team on Discord](https://hshno.de/discord). -## Code of Conduct - -Help us keep Appwrite open and inclusive. Please read and follow our [Code of Conduct](https://github.com/appwrite/.github/blob/main/CODE_OF_CONDUCT.md). - ## Submit a Pull Request 🚀 Branch naming convention is as following From 74ca63af3284c149595fd623e093e5d7e264ddfe Mon Sep 17 00:00:00 2001 From: Haimantika Mitra Date: Tue, 9 Jan 2024 16:27:13 +0530 Subject: [PATCH 3/3] Made changes to Contributing Guide --- CONTRIBUTING.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5c2c988b1..fd3c7c610 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -28,13 +28,13 @@ When `TYPE` can be: For the initial start, fork the project and use git clone command to download the repository to your computer. A standard procedure for working on an issue would be to: -1. `git pull`, before creating a new branch, pull the changes from upstream. Your master needs to be up to date. +1. `git pull`, before creating a new branch, pull the changes from upstream. Your main branch needs to be up to date. ``` $ git pull ``` -2. Create a new branch from `master` like: `feat-adds-profile-section`.
+2. Create a new branch from `main` like: `feat-adds-profile-section`.
``` $ git checkout -b [name_of_your_new_branch] @@ -58,7 +58,7 @@ $ git push origin [name_of_your_new_branch] ## Setup From Source -To set up a working **development environment**, just fork the project git repository and install the backend and frontend dependencies using the proper package manager and create run the docker-compose stack. +To set up a working **development environment**, just fork the project git repository and install the necessary packages with the `pnpm install` command. > If you just want to get started with Headless Hashnode for day-to-day use and not as a contributor, you can refer to the [guide](https://hashnode.com/headless) or the [README](README.md) file. @@ -69,8 +69,10 @@ cd starter-kit pnpm install -npm run dev +pnpm run dev ``` + Note- Make sure to run `pnpm run dev` in the correct folder. You can find more instructions about it in the [README]( https://github.com/Hashnode/starter-kit/?tab=readme-ov-file#running-locally) + ## Resources To stay updated with latest updates of Hashnode, you can follow: - [Changelog](https://hashnode.com/changelog)