Skip to content

Commit 586d297

Browse files
feat: created pull request templates and contribution guidelines (LelouchFR#55)
Co-authored-by: José Mateus <[email protected]>
1 parent 65b7358 commit 586d297

6 files changed

+119
-0
lines changed

.github/CONTRIBUTING.md

+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# Contributing to the Project
2+
3+
Thank you for your interest in contributing to our project! Here are some guidelines to help you get started.
4+
5+
## How to Contribute
6+
7+
### Reporting Bugs
8+
9+
1. **Check for existing issues:** Before reporting a bug, check the issue tracker to see if it has already been reported.
10+
2. **Create a new issue:** If the bug has not been reported, create a new issue and provide detailed information, including steps to reproduce the bug, screenshots, and any relevant logs.
11+
12+
### Suggesting Enhancements
13+
14+
1. **Check for existing suggestions:** Look through the issue tracker to see if your enhancement has already been suggested.
15+
2. **Create a new suggestion:** If it hasn't been suggested, open a new issue and describe the enhancement in detail, including its benefits and any potential drawbacks.
16+
17+
### Submitting Pull Requests
18+
19+
1. **Fork the repository:** Create a fork of the repository to work on your changes.
20+
2. **Make your changes:** Follow the coding standards and guidelines provided in this document.
21+
3. **Test your changes:** Ensure your changes are thoroughly tested.
22+
4. **Submit a pull request:** Open a pull request to the main repository and fill out the appropriate template.
23+
24+
#### Submitting a new Icon
25+
26+
1. Follow the exact same steps than [here](###Submitting_Pull_Requests)
27+
2. **Icon:** Use the placeholder svg to start your Icon.
28+
3. **Software:** Use Figma or Illustrator for making svg.
29+
30+
Download placeholders:
31+
32+
<a href="./placeholder-dark.svg" download>placeholder-dark.svg</a>
33+
34+
<a href="./placeholder-light.svg" download>placeholder-light.svg</a>
35+
36+
### Coding Standards
37+
38+
- **Style:** Follow the coding style used in the project.
39+
- **Documentation:** Ensure your code is well-documented.
40+
- **Commit messages:** Write clear and concise commit messages.
41+
42+
## Code of Conduct
43+
44+
Please adhere to our [Code of Conduct](CODE_OF_CONDUCT.md) in all your interactions with the project.
45+
46+
## Getting Help
47+
48+
If you need help or have questions, feel free to open an issue or contact one of the project maintainers.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Bug Fix: [Brief Description of Bug]
2+
3+
## Description
4+
5+
- **Issue:** Briefly describe the bug.
6+
- **Fix:** Explain what changes were made to fix the bug.
7+
8+
## Screenshots (if applicable)
9+
10+
- Before:
11+
![Before Fix](before_image_url)
12+
- After:
13+
![After Fix](after_image_url)
14+
15+
## Testing
16+
17+
- Steps to reproduce the issue and verify the fix.
18+
- Any relevant logs or error messages.
19+
20+
## Checklist
21+
22+
- [ ] Tested the fix locally
23+
- [ ] Added tests to cover the bug fix
24+
- [ ] Updated documentation if necessary
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Add New Feature: [Feature Name]
2+
3+
## Description
4+
5+
- **Feature:** Briefly describe the new feature.
6+
- **Implementation:** Explain how the feature was implemented.
7+
8+
## Screenshots (if applicable)
9+
10+
- Provide screenshots or examples demonstrating the new feature.
11+
12+
## Usage
13+
14+
- Instructions on how to use the new feature.
15+
- Any additional setup or configuration required.
16+
17+
## Checklist
18+
19+
- [ ] Implemented the new feature
20+
- [ ] Tested the new feature
21+
- [ ] Added or updated documentation
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Add New Icon(s)
2+
3+
## Icon Details
4+
5+
| Icon ID | Icon |
6+
|---------|------|
7+
| new-icon-id1 | ![image](image_url1) |
8+
| new-icon-id2 | ![image](image_url2) |
9+
10+
## Notes
11+
12+
- Provide any specific notes about the new icon(s), such as design choices, color adjustments, etc.
13+
- Mention if there were any deviations from the standard style or guidelines.
14+
15+
## Checklist
16+
17+
- [ ] Added icon(s) to the appropriate directory
18+
- [ ] Updated documentation with the new icon(s)
19+
- [ ] Verified the icon(s) display correctly
20+
- [ ] If the icon has light and dark, verified the auto switch works correctly

.github/placeholder-dark.svg

+3
Loading

.github/placeholder-light.svg

+3
Loading

0 commit comments

Comments
 (0)