diff options
| author | Ja.KooLit <ejhay.games@gmail.com> | 2023-12-29 15:38:18 +0900 |
|---|---|---|
| committer | Ja.KooLit <ejhay.games@gmail.com> | 2023-12-29 15:38:18 +0900 |
| commit | 69772de8b00a85a7da8e3d56c802fcfd01affe1c (patch) | |
| tree | ab297f40d72eab1dad7506e005cec1654f942ff6 /CONTRIBUTING.md | |
| parent | 203249972fd499909a2f81dfad64d7c9abe7b191 (diff) | |
Update for contributing
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 70 |
1 files changed, 70 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..17d570c7 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,70 @@ +# Contributing to Community Standards + +Thank you for your interest in contributing to Community Standards! We welcome any contributions, including bug fixes, feature enhancements, documentation improvements, and other general improvements. + +## Getting Started + +1. Fork the branch development repository to your GitHub account. This will create a copy of this repository in your account. You can make changes to this copy without affecting the original repository. + - For fork this repository, click the **Fork** button in the top right corner of this page or click [here](https://github.com/JaKooLit/Hyprland-Dots/fork). + - Make sure to uncheck the Copy the `main` branch only. This will copy the development branch and other branches (if any) + +2. Clone your forked repository to your local machine. + + - Use the following command to clone your forked repository to your local machine. + + ```bash + git clone --depth=1 -b development https://github.com/JaKooLit/Hyprland-Dots.git + ``` + +3. Create a new branch for your changes. + + - For example, to create a new branch named `your-branch-name`, use the following command. + + ```bash + git checkout -b your-branch-name + ``` + +4. Make your changes and commit them with a descriptive commit message. + + - For example, to commit your changes, use the following command and make sure to follow the [commit message guidelines](https://github.com/JaKooLit/Hyprland-Dots/blob/main/COMMIT_MESSAGE_GUIDELINES.md). + + ```bash + git commit -m "feat: add a new feature" + ``` + +5. Push your changes to your forked repository. + + - For example, to push your changes to your forked repository, use the following command. + + ```bash + git push origin your-branch-name + ``` + +6. Submit a **pull request** to the development branch repository. + - For example, to create a pull request, use the following steps. + 1. Go to your forked repository. + 2. Click the **Compare & pull request** button next to your `your-branch-name` branch. + 3. Add a title and description for your pull request. + 4. Click **Create pull request** and remember to add the relevant labels with using the [pull request template](https://github.com/JaKooLit/Hyprland-Dots/blob/templates/.github/PULL_REQUEST_TEMPLATE.md). + +## Guidelines + +- Follow the code style of the project. +- Update the **documentation** if necessary. +- Add tests if applicable. +- Make sure all tests pass before submitting your changes. +- Keep your pull request focused and avoid including unrelated changes. +- Remeber to follow the given files before submitting your changes. + - [bug_report.md](https://github.com/JaKooLit/Hyprland-Dots/blob/main/.github/ISSUE_TEMPLATE/bug_report.md) - Use this template to create a report to help us improve. + - [feature_request.md](https://github.com/JaKooLit/Hyprland-Dots/blob/main/.github/ISSUE_TEMPLATE/feature_request.md) - Use this template to suggest a feature for this project. + - [documentation_update.md](https://github.com/JaKooLit/Hyprland-Dots/blob/main/.github/ISSUE_TEMPLATE/documentation_update.md) - Use this template to propose a change to the documentation. + - [custom.md](https://github.comJaKooLit/Hyprland-Dots/blob/main/.github/ISSUE_TEMPLATE/custom.md) - Use this template to submit a custom issue. + - [PULL_REQUEST_TEMPLATE.md](https://github.com/JaKooLit/Hyprland-Dots/blob/main/.github/PULL_REQUEST_TEMPLATE.md) - Use this template to submit a pull request. + - [COMMIT_MESSAGE_GUIDELINES.md](https://github.com/JaKooLit/Hyprland-Dots/blob/main/COMMIT_MESSAGE_GUIDELINES.md) - Read this file to learn about the commit message guidelines. + - [CONTRIBUTING.md](https://github.com/JaKooLit/Hyprland-Dots/blob/main/CONTRIBUTING.md) - Read this file to learn about the contributing guidelines. + - [LICENSE](https://github.com/JaKooLit/Hyprland-Dots/blob/main/LICENSE) - Read this file to learn about the license. + - [README.md](https://github.com/JaKooLit/Hyprland-Dots/blob/main/README.md) - Read this file to learn about the project. + +## Contact + +If you have any questions, feel free to contact via [GitHub Discussions](https://github.com/JaKooLit/Hyprland-Dots/discussions) or [Through Discord Server](https://discord.gg/V2SJ92vbEN) |
