-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Co-authored-by: Almanov Nikita <131481562+nikkeyl@users.noreply.github.com>
- Loading branch information
1 parent
819ae9f
commit 4a84874
Showing
10 changed files
with
165 additions
and
66 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -7,7 +7,7 @@ on: | |
|
|
||
| jobs: | ||
| pre-commit: | ||
| name: Pre-commit | ||
| name: Pre Commit | ||
|
|
||
| if: ${{ github.actor != 'dependabot[bot]' }} | ||
|
|
||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,33 +1,65 @@ | ||
| # Contributing | ||
| # Contributing Guide | ||
|
|
||
| First off, thanks for taking the time to contribute! | ||
| Thank you for considering contributing to our project! | ||
| Your contributions help improve the project and enrich our community. | ||
|
|
||
| ## Code of Conduct | ||
|
|
||
| This project and everyone participating in it is governed by the | ||
| [**Code of Conduct**](CODE_OF_CONDUCT.md). | ||
| By participating, you are expected to uphold this code. | ||
| All participants in this project are expected to adhere to our | ||
| [Code of Conduct](CODE_OF_CONDUCT.md). | ||
| By participating, you are agreeing to foster a welcoming | ||
| and respectful environment for everyone involved. | ||
|
|
||
| ## Before Submitting Your Issue | ||
|
|
||
| Make sure there is no same or similar issue. | ||
| Before you create a new **issue**, please take a moment to search through | ||
| the existing **issues** to see if your concern has already been reported | ||
| or addressed. | ||
| This helps us manage issues more effectively and avoids duplicate reports. | ||
|
|
||
| ## The Title of Your Pull Request or Issue | ||
| ## Title Format for Pull Requests and Issues | ||
|
|
||
| Must conform to the conventional commits standard, | ||
| example: `<type>[optional scope]: <description>`. | ||
| To maintain clarity and consistency, please ensure that the title | ||
| of your **Pull Request** or issue meets the conventional commits standard. | ||
|
|
||
| A proper title should be in the format: `<type>[optional scope]: <description>` | ||
| > Example: `feat(ui): add dark mode toggle` | ||
| ## Reporting Bugs | ||
|
|
||
| Go to **Issue > New Issue > Report a Bug**. | ||
| Follow the instructions on the form. | ||
| If you have found a bug, please follow these steps: | ||
|
|
||
| 1. Go to `Issue > New Issue > Report a Bug`. | ||
|
|
||
| 1. Complete the form with as much detail as possible, including: | ||
|
|
||
| - Steps to reproduce the issue; | ||
| - Expected behavior; | ||
| - Actual behavior; | ||
| - Any relevant logs or screenshots; | ||
|
|
||
| ## Suggesting Features | ||
|
|
||
| Go to **Issue > New Issue > Request a Feature**. | ||
| Follow the instructions on the form. | ||
| Have an idea to improve the project? We want to hear it! | ||
|
|
||
| 1. Go to `Issue > New Issue > Request a Feature`. | ||
|
|
||
| 1. Provide a comprehensive description of the feature, including: | ||
|
|
||
| - Problem it solves; | ||
| - Benefits of the feature; | ||
| - Any potential drawbacks or considerations; | ||
|
|
||
| ## Improve Documentation | ||
|
|
||
| Go to **Issue > New Issue > Report a Docs Issue**. | ||
| Follow the instructions on the form. | ||
| We appreciate any efforts to enhance our documentation! | ||
|
|
||
| 1. Go to `Issue > New Issue > Report a Docs Issue`. | ||
|
|
||
| - Indicate what part of the documentation needs improvement | ||
| and suggest your updates; | ||
|
|
||
| - Be specific about what you believe needs clarification | ||
| or additional detail; | ||
|
|
||
| Thank you for your contributions! Together, we can make this project even better. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,32 +1,57 @@ | ||
| ## Pull Request template | ||
| # Pull Request Template | ||
|
|
||
| Please, go through these steps before you submit a **Pull Request**. | ||
| Thank you for contributing to our project! | ||
|
|
||
| - Make sure that your **Pull Request** is not a duplicate. | ||
| Please follow the steps below before | ||
| submitting your **Pull Request**. | ||
|
|
||
| - If not, then make sure that: | ||
| ## Pre-submission Checklist | ||
|
|
||
| - You have done your changes in a separate branch. | ||
| Branches MUST have descriptive names that start with either: | ||
| `fix/`, `feature/` or `refactor/` prefixes. | ||
| - [ \] **Duplicate Check**: Ensure that your **Pull Request** | ||
| is not a duplicate of an existing one. | ||
|
|
||
| > Example: | ||
| > | ||
| > Good: `fix/signin-issue`, `feature/issue-templates` or `refactor/button`. | ||
| > If your **Pull Request** is not a duplicate, please make sure you have: | ||
| - You have a descriptive commit message with a short title (first line). | ||
| - [ \] **Separate Branch**: Created your changes in a separate branch. | ||
| Ensure that branch names are descriptive | ||
| and start with one of the following prefixes: | ||
|
|
||
| - Make sure there are no errors in the code. | ||
| > - `fix/`: for bug fixes; | ||
| > - `feature/`: for new features; | ||
| > - `refactor/`: for code improvements without changing functionality; | ||
| - **After** these steps, you're ready to open a **Pull Request**. | ||
| ## Example of Good Branch Names | ||
|
|
||
| - Give a descriptive title to your **Pull Request**. | ||
| > - `fix/signin-issue`; | ||
| > - `feature/add-issue-templates`; | ||
| > - `refactor/improve-button-styling`; | ||
| - Describe your changes. | ||
| - [ \] **Descriptive Commit Message**: Used a clear and concise commit | ||
| message that includes a short title on the first line. | ||
| For example, use imperative tense and focus on the *what* and *why*. | ||
|
|
||
| - Put `closes #XXXX` in your comment to auto-close | ||
| the Issue that your **Pull Request** fixes (if such). | ||
| - [ \] **Error Check**: Ensured there are no errors or warnings in your code. | ||
| Compile and test your changes if applicable. | ||
|
|
||
| IMPORTANT: Please see our **Contribution Guidelines** for details. | ||
| ## Submitting Your Pull Request | ||
|
|
||
| **PLEASE REMOVE THIS TEMPLATE BEFORE SUBMITTING** | ||
| - [ \] **Pull Request Title**: Choose a descriptive title for your | ||
| **Pull Request** that summarizes the changes. | ||
|
|
||
| - [ \] **Pull Request Description**: Provide a detailed description | ||
| of the changes you made, including any additional context or considerations. | ||
|
|
||
| - [ \] **Issue Closure Reference**: If your **Pull Request** addresses an | ||
| existing issue, include closes `#XXX` in the **Pull Request** description | ||
| to automatically close that issue when your **Pull Request** is merged | ||
| (replace `XXX` with the issue number). | ||
|
|
||
| ## Important Reminders | ||
|
|
||
| Please review our *Contribution Guidelines* for additional details | ||
| regarding our *coding standards and best practices*. | ||
|
|
||
| **IMPORTANT**: Please remove this template | ||
| before submitting your **Pull Request**. | ||
|
|
||
| Thank you for helping improve our project! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,10 @@ | ||
| <a href="https://github.com/archoleat/.github/blob/main/README.md"> | ||
| <img src="../assets/label.jpg" alt="Archoleat Science"> | ||
| </a> | ||
| [](https://github.com/archoleat/.github/blob/main/README.md) | ||
|
|
||
| In our organization, we create, automate, experiment, | ||
| standardize, test, and simplify workflows. | ||
| Welcome to **Archoleat Science**! | ||
| Our organization is dedicated to transforming workflows through creativity | ||
| and innovation. We strive to create, automate, experiment, standardize, test, | ||
| and simplify processes to foster efficiency | ||
| and effectiveness in various domains. | ||
|
|
||
| Thank you for visiting **Archoleat Science**! | ||
| Together, let's redefine what’s possible in workflow innovation. |