Skip to content

Commit febeb78

Browse files
committed
Add CONTRIBUTING.md file
1 parent bb77238 commit febeb78

File tree

1 file changed

+72
-0
lines changed

1 file changed

+72
-0
lines changed

CONTRIBUTING.md

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
# Contributing to react-lazy-load-image-component
2+
3+
Thank you for considering contributing to react-lazy-load-image-component! We appreciate your support and welcome any contributions you can make to enhance the package.
4+
5+
The following guidelines will help you understand how to contribute effectively:
6+
7+
## Ways to Contribute
8+
9+
There are several ways you can contribute to the project:
10+
11+
1. Report Issues
12+
2. Suggest Enhancements
13+
3. Answer Open Issues
14+
4. Submit Pull Requests
15+
16+
## Reporting Issues
17+
18+
If you encounter any issues or bugs while using react-lazy-load-image-component, please help us improve by reporting them. To report an issue, follow these steps:
19+
20+
1. Check if the issue has already been reported by searching the [GitHub Issues](https://github.com/Aljullu/react-lazy-load-image-component/issues) of the repository.
21+
2. If the issue hasn't been reported, click on the "New Issue" button.
22+
3. Provide a clear and descriptive title for the issue.
23+
4. Describe the steps to reproduce the issue, including any relevant code snippets or error messages.
24+
5. Explain the expected behavior and the actual behavior you observed.
25+
6. Add any additional information, such as screenshots or environment details, that may be helpful.
26+
7. Finally, submit the issue and await further instructions or clarifications.
27+
28+
## Suggesting Enhancements
29+
30+
We welcome suggestions for enhancing react-lazy-load-image-component. If you have an idea for a new feature, or you believe an existing feature can be improved, please follow these steps:
31+
32+
1. Check the [GitHub Issues](https://github.com/Aljullu/react-lazy-load-image-component/issues) of the repository to see if a similar suggestion has already been made.
33+
2. If your suggestion hasn't been proposed yet, click on the "New Issue" button.
34+
3. Provide a clear and descriptive title for the enhancement.
35+
4. Describe the current limitations or problems you're experiencing that your suggested enhancement aims to address.
36+
5. Clearly explain how your suggested enhancement would improve the package.
37+
6. Include any relevant code examples, if applicable.
38+
7. Submit the enhancement suggestion and await further discussion or feedback.
39+
40+
## Answering Open Issues
41+
42+
You can contribute to react-lazy-load-image-component by helping to answer open issues in the GitHub repository. This includes:
43+
44+
- Helping users solve their problems or find workarounds.
45+
- Replicating reported bugs and providing additional information or insights.
46+
- Sharing your knowledge and expertise to assist other users.
47+
48+
To contribute in this way, follow these steps:
49+
50+
1. Visit the [GitHub Issues](https://github.com/Aljullu/react-lazy-load-image-component/issues) page of the repository.
51+
2. Look for open issues that you can provide assistance with.
52+
3. Read through the issue description and any existing comments to understand the problem or question.
53+
4. If you can reproduce the issue, follow the steps provided and document your findings in a comment.
54+
5. Offer suggestions, workarounds, or explanations to help resolve the issue.
55+
6. Engage in respectful and constructive conversations with the issue reporter and other contributors.
56+
57+
## Submitting Pull Requests
58+
59+
We encourage you to contribute directly to the codebase of react-lazy-load-image-component by submitting pull requests (PRs). Follow these steps to submit a PR:
60+
61+
1. Fork the repository to your GitHub account.
62+
2. Create a new branch with a descriptive name for your changes.
63+
3. Implement your changes or new features. When developing, you can use `npm run start` and `npm run build` to build your changes.
64+
4. Include tests that cover your changes and update the documentation, if applicable.
65+
5. Make sure the codebase passes all existing tests (run `npm run test`) and lint checks (`npm run lint`).
66+
6. Commit your changes with a clear and concise commit message.
67+
7. Push your branch to your forked repository.
68+
8. Open a PR against the `master` branch of the original repository.
69+
9. Provide a detailed description of your changes in the PR, including the problem or feature addressed.
70+
10. Engage in any further discussion or feedback requested on the PR.
71+
72+
Once your PR is reviewed and approved, it will be merged into the main codebase, and your contributions will become part of react-lazy-load-image-component!

0 commit comments

Comments
 (0)