Skip to content

Commit ce0cad3

Browse files
cagla88cagla88
authored
AYS-521 | Documents Editing (#47)
1 parent 9d69a85 commit ce0cad3

File tree

3 files changed

+221
-11
lines changed

3 files changed

+221
-11
lines changed

‎CODEOWNERS

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# These owner(s) will be the default owners for everything in the repo.
22

3-
* @agitrubard @yvzcnr @Nbhtozcn @cagla88 @TekinMerve
3+
* @agitrubard @Nbhtozcn @cagla88

‎CONTRIBUTING.md

Lines changed: 182 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,182 @@
1+
# Contributing Guidelines
2+
3+
Thank you for considering contributing to the "afet-yonetim-sistemi" project! We appreciate your interest and
4+
welcome any contributions that can help us improve the project.
5+
6+
Please take a moment to review these guidelines before making any contributions. Following these guidelines will
7+
help you maintain a collaborative and inclusive environment for everyone involved.
8+
9+
## Table of Contents
10+
11+
- [How to Contribute](#how-to-contribute)
12+
- [Reporting Issues](#reporting-issues)
13+
- [Submitting Changes](#submitting-changes)
14+
- [Code Style](#code-style)
15+
- [Commit Messages](#commit-messages)
16+
- [Documentation](#documentation)
17+
- [Community Guidelines](#community-guidelines)
18+
19+
## How to Contribute
20+
21+
Thank you for considering contributing to our UI automation project! To make the process smooth,
22+
please follow these steps:
23+
24+
1. **Join Our Discord Server:**
25+
- Join our [Discord server](https://discord.com/invite/NkAkYajkKa) to engage with the community and
26+
project maintainers.
27+
- Navigate to the 'Environment Information' section and find the GitHub thread. Leave a message in the thread to
28+
express your interest in contributing.
29+
30+
2. **Review Jira Issues:**
31+
- Access our [Jira Issues](https://afetyonetimsistemi.atlassian.net/jira/software/c/projects/AYS/issues/AYS-408?filter=allissues&jql=project%20%3D%20%22AYS%22%20AND%20status%20%3D%20Ready%20AND%20assignee%20%3D%20empty%20ORDER%20BY%20created%20DESC) to view the issues and development tasks.
32+
- Identify relevant issues or features you would like to work on.
33+
34+
3. **Cloning the Project:**
35+
- Once added to the GitHub organization, clone the repository from the organization’s GitHub page.
36+
- Clone the repository using the command: `git clone https://github.com/afet-yonetim-sistemi/ays-fe-ui-automation`
37+
38+
4. **Create a New Branch:**
39+
- Create a branch for your contribution based on the `main` branch.
40+
- Refer to the [Naming Conventions of Branches](#branch-naming-conventions) for guidance on branch naming.
41+
- Ensure your feature branch is associated with the relevant Jira issue and GitHub issue if applicable.
42+
43+
5. **Make Changes:**
44+
- Implement your changes in the branch you created.
45+
46+
6. **Commit Changes:**
47+
- Commit your changes with clear and concise messages. Refer to the [Commit Messages](#commit-messages) section for
48+
guidance.
49+
50+
7. **Push Changes:**
51+
- Push your changes to the `main` branch of your cloned repository.
52+
53+
8. **Open a Pull Request (PR):**
54+
- Open a PR against the `main` branch of the original repository.
55+
- Provide a detailed description of your changes in the PR.
56+
- Link relevant Jira issues and GitHub issues in the PR description.
57+
- Follow the pull request naming conventions outlined below.
58+
- PR title should contain the Jira issue number and a brief description of the change.
59+
60+
9. **Review and Feedback:**
61+
- Once your PR is submitted, project maintainers will review it and provide feedback.
62+
- Be responsive to feedback and make necessary changes.
63+
64+
## Development Standards
65+
66+
Our project adheres to the [GitHub Flow](https://docs.github.com/en/get-started/quickstart/github-flow) for
67+
collaboration.
68+
Issues are managed on GitHub Discussions, with plans to transition them to Jira.
69+
70+
### Branch Naming Conventions:
71+
72+
- `test/{jira-issue-number}/{optional-description}`
73+
- `feature/{jira-issue-number}/{optional-description}`
74+
- `refactor/{jira-issue-number}/{optional-description}`
75+
76+
> Example : `feature/AYS-1/add-login-test`
77+
78+
### Pull Request Naming Conventions:
79+
80+
- `{jira-issue-number} | {header-for-summary-of-development}`
81+
82+
> Example : `AYS-1 | Add login functionality tests`
83+
84+
Here are some additional standards to keep in mind:
85+
86+
- Link your feature branch to the corresponding GitHub issue.
87+
- The `main` branch is protected.
88+
- PR should be linked to the relevant issue within the GitHub Project.
89+
- Only one code owner's approval is needed for merging feature branches.
90+
- PR should be squash-merged to avoid merge commit history.
91+
- PR should pass build and necessary tests before merging.
92+
- Releases should be tagged with a version.
93+
- Commit messages should be subjectless.
94+
- Resolve comments within the PR by the commenter.
95+
- PR should be concise and address one thing.
96+
- Avoid including secret/credential information.
97+
- Code should comply with existing coding standards; no new standards should be introduced without justification.
98+
99+
## Reporting Issues
100+
101+
If you encounter any bugs, have feature requests, or want to provide general feedback, please feel free to open a
102+
discussion in the "afet-yonetim-sistemi" repository. When creating a discussion,
103+
please provide as much detail as possible, including:
104+
105+
- A clear and descriptive title
106+
- Steps to reproduce the issue
107+
- Expected behavior
108+
- Actual behavior
109+
- Any error messages or logs
110+
111+
## Submitting Changes
112+
113+
When submitting changes, please ensure the following:
114+
115+
- Your code adheres to the project's [code style guidelines](#code-style).
116+
- The documentation has been updated, if necessary (see [Documentation](#documentation)).
117+
- Your commits are clean and have clear commit messages (see [Commit Messages](#commit-messages)).
118+
119+
## Code Style
120+
121+
To maintain a consistent codebase, please follow the existing code style used in the project. If necessary,
122+
refer to any code style guidelines mentioned in the repository.
123+
124+
## Commit Messages
125+
126+
Writing clear and descriptive commit messages is essential for the maintainability of the project. Follow these
127+
guidelines when writing commit messages:
128+
129+
- **Be Clear and Concise:**
130+
- Ensure the subject line clearly summarizes the change. While it’s useful to start with a verb
131+
(e.g., "Fix," "Add," "Update"), the main goal is to make sure the message is clear and easily understandable.
132+
133+
- **Provide Additional Details:**
134+
- Include additional details in the commit message body if necessary.
135+
- Explain the reason for the change and provide context to help reviewers understand the impact and
136+
purpose of the change.
137+
138+
- **Squash and Merge:**
139+
- We use the Squash and Merge strategy for integrating pull requests. This method combines all commits in
140+
a pull request into a single commit before merging.
141+
- As a result, the pull request title becomes the final commit message. Ensure the title is descriptive and
142+
accurately reflects the overall change.
143+
- Example pull request title: `Enhance UI Tests For Login Functionality`
144+
145+
- **Example Commit Message:**
146+
```
147+
Add new feature for user login automation test
148+
149+
- AYS-0 : Add new scenarios for login tests
150+
- Implement Cucumber scenarios for login feature
151+
- AYS-0 | Add validation for error messages
152+
```
153+
154+
By following these guidelines, you contribute to a clear and understandable project history, facilitating easier code
155+
reviews and collaboration.
156+
157+
## Documentation
158+
159+
Clear and up-to-date documentation is crucial for the project's users and contributors. If your contribution introduces
160+
new features, modifies existing functionality, or requires changes to the documentation, please make the necessary updates.
161+
162+
Follow these guidelines for documenting your changes:
163+
164+
- Update the relevant documentation files to reflect your changes.
165+
- Write clear and concise explanations.
166+
- Use code examples or screenshots, if appropriate, to enhance understanding.
167+
- Proofread your documentation to ensure it is accurate and free of errors.
168+
169+
## Community Guidelines
170+
171+
In addition to the technical aspects, it is important to follow the community guidelines to maintain a positive and
172+
inclusive environment for all contributors.
173+
174+
- Be respectful and considerate of others' opinions and ideas.
175+
- Be open to feedback and willing to collaborate with other contributors.
176+
- Avoid personal attacks, offensive language, and harassment.
177+
- If you notice any inappropriate behavior, report it to the project maintainers.
178+
179+
By adhering to these guidelines, we can work together to build a welcoming and productive community.
180+
181+
Thank you for your interest in contributing to the "afet-yonetim-sistemi" project! We appreciate your support and
182+
look forward to your contributions.

‎PULL_REQUEST_TEMPLATE.md

Lines changed: 38 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,20 +3,48 @@
33
**Description:**
44
Provide a brief description of the changes in this pull request.
55

6-
**Related Issue:**
7-
Closes #[Issue Number]
8-
96
**Changes Made:**
107
List the changes you made in this pull request.
118

129
**Additional Information:**
1310
Add any additional information that might be relevant to reviewers.
1411

15-
## Checklist
16-
- [ ] I have read and followed the [contribution guidelines](README.md#contributing) for this project.
17-
- [ ] I have added tests (if applicable).
18-
- [ ] All tests are passing.
19-
- [ ] I have updated the documentation (if necessary).
20-
21-
## Reviewer Instructions
12+
**Reviewer Instructions:**
2213
Provide instructions or guidelines for reviewers to follow when assessing your pull request.
14+
15+
### Checklist
16+
17+
Before submitting your pull request, ensure the following:
18+
19+
- [ ] **Title and Branch Naming Conventions:**
20+
- The pull request title follows the
21+
standard: [Pull Request Naming Conventions](https://github.com/afet-yonetim-sistemi/ays-fe-ui-automation/blob/main/CONTRIBUTING.md#pull-request-naming-conventions)
22+
.
23+
- The branch name follows one of the conventions outlined in
24+
the [Branch Naming Conventions](https://github.com/afet-yonetim-sistemi/ays-fe-ui-automation/blob/main/CONTRIBUTING.md#branch-naming-conventions)
25+
.
26+
27+
- [ ] **Local Testing:**
28+
- I have added positive and negative test scenarios (if applicable)
29+
- All tests are passing.
30+
- I tagged all test as smoke or regression
31+
- I added newly added tests to related xml file in test suite
32+
33+
- [ ] **Code Quality:**
34+
- The code is formatted according to the project's coding guidelines and style.
35+
- The code has been reviewed to ensure its quality.
36+
- The code does not contain any issues flagged by SonarLint.
37+
38+
- [ ] **Documentation:**
39+
- Necessary documentation has been added or existing documentation has been updated.
40+
41+
- [ ] **Reviewers and Assignees:**
42+
- Default reviewers have been assigned to this pull request.
43+
- Assignees have been added if necessary.
44+
45+
- [ ] **Labels and Associations:**
46+
- No specific actions are required in the Labels and Associations section for this pull request.
47+
48+
- [ ] **Reviewer Instructions:**
49+
- Provide instructions or guidelines for reviewers to follow when assessing your pull request.
50+

0 commit comments

Comments
 (0)