Skip to content

Commit aad7082

Browse files
committed
added community standards files
1 parent 0d87294 commit aad7082

File tree

4 files changed

+153
-0
lines changed

4 files changed

+153
-0
lines changed
File renamed without changes.

.github/CONTRIBUTING.md

+112
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
# Contribution Guidelines
2+
3+
Thank you for considering contributing to this project! Your help is greatly appreciated. Below are some guidelines to
4+
follow to make the contribution process smooth and effective for everyone involved.
5+
6+
## How to Contribute
7+
8+
1. **Fork the Repository**:
9+
- Navigate to the repository you want to contribute to.
10+
- Click the "Fork" button at the top right corner of the page.
11+
12+
2. **Clone Your Fork**:
13+
- Open your terminal and run:
14+
```sh
15+
git clone https://github.com/RanitManik/JavaScript-Projects.git
16+
```
17+
18+
3. **Create a Branch**:
19+
- Move into the cloned directory:
20+
```sh
21+
cd JavaScript-Projects
22+
```
23+
- Create a new branch for your changes:
24+
```sh
25+
git checkout -b feature-branch-name
26+
```
27+
28+
4. **Make Your Changes**:
29+
- Implement your changes in your local repository.
30+
31+
5. **Commit Your Changes**:
32+
- Add your changes:
33+
```sh
34+
git add .
35+
```
36+
- Commit your changes with a meaningful message:
37+
```sh
38+
git commit -m "Description of changes"
39+
```
40+
41+
6. **Push to Your Fork**:
42+
- Push your changes to your forked repository:
43+
```sh
44+
git push origin feature-branch-name
45+
```
46+
47+
7. **Create a Pull Request**:
48+
- Go to the original repository.
49+
- Click the "New Pull Request" button.
50+
- Select the branch you created and click "Create Pull Request".
51+
- Provide a detailed description of your changes in the pull request.
52+
53+
## Code Style
54+
55+
- Follow the coding standards and style guides of the project.
56+
- Write clean, readable, and maintainable code.
57+
- Add comments where necessary to explain complex logic or decisions.
58+
59+
## Testing
60+
61+
- Ensure that your changes do not break any existing functionality.
62+
- Write tests to cover new or changed functionality if applicable.
63+
- Run all tests to confirm that everything works as expected.
64+
65+
## Documentation
66+
67+
- Update the documentation if your changes include new features or modifications.
68+
- Ensure that your documentation is clear, concise, and easy to understand.
69+
70+
## Commit Messages
71+
72+
- Use clear and concise commit messages.
73+
- Follow the format:
74+
```
75+
[type]: [subject]
76+
77+
[body]
78+
79+
[footer]
80+
```
81+
82+
Example:
83+
```
84+
feat: add new feature for user authentication
85+
86+
Implemented user login and registration functionality.
87+
Added tests for the new feature.
88+
89+
Closes #123
90+
```
91+
92+
## Issue Reporting
93+
94+
- If you find a bug, create an issue before submitting a pull request.
95+
- Provide a detailed description of the bug, including steps to reproduce it.
96+
- If possible, include screenshots or code snippets to help illustrate the issue.
97+
98+
## Pull Request Review
99+
100+
- Be patient and respectful while waiting for your pull request to be reviewed.
101+
- Address any feedback or requested changes promptly and thoughtfully.
102+
- Engage in discussions and provide clarifications if needed.
103+
104+
## Code of Conduct
105+
106+
- Follow the project's code of conduct.
107+
- Be respectful, inclusive, and considerate in your interactions.
108+
- Help create a welcoming and positive environment for all contributors.
109+
110+
---
111+
112+
We appreciate your contribution and look forward to collaborating with you!

SECURITY.md .github/SECURITY.md

File renamed without changes.

.github/pull_request_template.md

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
## Description
2+
3+
Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List
4+
any dependencies that are required for this change.
5+
6+
Fixes #(issue)
7+
8+
## Type of change
9+
10+
Please delete options that are not relevant.
11+
12+
- [ ] Bug fix (non-breaking change which fixes an issue)
13+
- [ ] New feature (non-breaking change which adds functionality)
14+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
15+
- [ ] This change requires a documentation update
16+
17+
## How Has This Been Tested?
18+
19+
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also
20+
list any relevant details for your test configuration.
21+
22+
- [ ] Test A
23+
- [ ] Test B
24+
25+
**Test Configuration**:
26+
27+
* Firmware version:
28+
* Hardware:
29+
* Toolchain:
30+
* SDK:
31+
32+
## Checklist:
33+
34+
- [ ] My code follows the style guidelines of this project
35+
- [ ] I have performed a self-review of my own code
36+
- [ ] I have commented my code, particularly in hard-to-understand areas
37+
- [ ] I have made corresponding changes to the documentation
38+
- [ ] My changes generate no new warnings
39+
- [ ] I have added tests that prove my fix is effective or that my feature works
40+
- [ ] New and existing unit tests pass locally with my changes
41+
- [ ] Any dependent changes have been merged and published in downstream modules

0 commit comments

Comments
 (0)