From 3f3f6cfc3699c95ac104e12658d01ff9a40d686a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sergio=20La=C3=ADn?= Date: Fri, 29 Dec 2023 00:11:44 +0100 Subject: [PATCH] =?UTF-8?q?=E2=9C=A8=20feat(docs):=20added=20CONTRIBUTING?= =?UTF-8?q?=20and=20COMMIT=5FMESSAGE=5FGUIDELINES=20markdown=20files=20to?= =?UTF-8?q?=20the=20repo?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/COMMIT_MESSAGE_GUIDELINES.md | 151 +++++++++++++++++++++++++++ .github/CONTRIBUTING.md | 68 ++++++++++++ 2 files changed, 219 insertions(+) create mode 100644 .github/COMMIT_MESSAGE_GUIDELINES.md create mode 100644 .github/CONTRIBUTING.md diff --git a/.github/COMMIT_MESSAGE_GUIDELINES.md b/.github/COMMIT_MESSAGE_GUIDELINES.md new file mode 100644 index 00000000..17c13e14 --- /dev/null +++ b/.github/COMMIT_MESSAGE_GUIDELINES.md @@ -0,0 +1,151 @@ +# Commit Message Guidelines + +A good commit message should be descriptive and provide context about the changes made. This makes it easier to understand and review the changes in the future. + +Here are some guidelines for writing descriptive commit messages: + +- Start with a short summary of the changes made in the commit. + +- Use imperative mood for the summary, as if you're giving a command. For example, "Add feature" instead of "Added feature". + +- Provide additional details in the commit message body, if necessary. This could include the reason for the change, the impact of the change, or any dependencies that were introduced or removed. + +- Keep the message within 72 characters per line to ensure that it's easy to read in Git log output. + +Examples of good commit messages: + +- "Add authentication feature for user login" +- "Fix bug causing application to crash on startup" +- "Update documentation for API endpoints" + +Remember, writing descriptive commit messages can save time and frustration in the future, and help others understand the changes made to the codebase. + +## Commit Message Types + +Here's a more comprehensive list of commit types that you can use: + +`feat`: Adding a new feature to the project + +```markdown +feat: Add multi-image upload support +``` + +`fix`: Fixing a bug or issue in the project + +```markdown +fix: Fix bug causing application to crash on startup +``` + +`docs`: Updating documentation in the project + +```markdown +docs: Update documentation for API endpoints +``` + +`style`: Making cosmetic or style changes to the project (such as changing colors or formatting code) + +```markdown +style: Update colors and formatting +``` + +`refactor`: Making code changes that don't affect the behavior of the project, but improve its quality or maintainability + +```markdown +refactor: Remove unused code +``` + +`test`: Adding or modifying tests for the project + +```markdown +test: Add tests for new feature +``` + +`chore`: Making changes to the project that don't fit into any other category, such as updating dependencies or configuring the build system + +```markdown +chore: Update dependencies +``` + +`perf`: Improving performance of the project + +```markdown +perf: Improve performance of image processing +``` + +`security`: Addressing security issues in the project + +```markdown +security: Update dependencies to address security issues +``` + +`merge`: Merging branches in the project + +```markdown +merge: Merge branch 'feature/branch-name' into develop +``` + +`revert`: Reverting a previous commit + +```markdown +revert: Revert "Add feature" +``` + +`build`: Making changes to the build system or dependencies of the project + +```markdown +build: Update dependencies +``` + +`ci`: Making changes to the continuous integration (CI) system for the project + +```markdown +ci: Update CI configuration +``` + +`config`: Making changes to configuration files for the project + +```markdown +config: Update configuration files +``` + +`deploy`: Making changes to the deployment process for the project + +```markdown +deploy: Update deployment scripts +``` + +`init`: Creating or initializing a new repository or project + +```markdown +init: Initialize project +``` + +`move`: Moving files or directories within the project + +```markdown +move: Move files to new directory +``` + +`rename`: Renaming files or directories within the project + +```markdown +rename: Rename files +``` + +`remove`: Removing files or directories from the project + +```markdown +remove: Remove files +``` + +`update`: Updating code, dependencies, or other components of the project + +```markdown +update: Update code +``` + +These are just some examples, and you can create your own custom commit types as well. However, it's important to use them consistently and write clear, descriptive commit messages to make it easy for others to understand the changes you've made. + +Emojis are also allowed, always following the commit guidelines mention before. + +**Important:** If you are planning to use a custom commit message type other than the ones listed above, make sure to add it to this list so that others can understand it as well. Create a pull request to add it to this file. diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 00000000..3530b8b3 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,68 @@ +# 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 this 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/prasanthrangan/hyprdots/fork). +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 https://github.com/Matt-FTW/dotfiles.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](./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 upstream 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](./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. +- Remember to follow the given files before submitting your changes. + - [bug_report.yml](./ISSUE_TEMPLATE/bug_report.yml) - Use this template to create a report to help us improve. + - [feature_request.yml](./ISSUE_TEMPLATE/feature_request.yml) - Use this template to suggest a feature for this project. + - [documentation_update.yml](./ISSUE_TEMPLATE/documentation_update.yml) - Use this template to propose a change to the documentation. + - [custom.md](./ISSUE_TEMPLATE/custom.md) - Use this template to submit a custom issue. + - [PULL_REQUEST_TEMPLATE.md](./PULL_REQUEST_TEMPLATE.md) - Use this template to submit a pull request. + - [COMMIT_MESSAGE_GUIDELINES.md](./COMMIT_MESSAGE_GUIDELINES.md) - Read this file to learn about the commit message guidelines. + - [CONTRIBUTING.md](./CONTRIBUTING.md) - Read this file to learn about the contributing guidelines. + - [LICENSE](../LICENSE) - Read this file to learn about the license. + - [README.md](./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/Matt-FTW/dotfiles/discussions) or via email at sergiolain11@gmail.com