Skip to content

Commit b597aeb

Browse files
xonx4lpenberg
authored andcommitted
Update CONTRIBUTING.md
1 parent b9c9fec commit b597aeb

File tree

1 file changed

+51
-1
lines changed

1 file changed

+51
-1
lines changed

CONTRIBUTING.md

Lines changed: 51 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,51 @@
1-
A file to explicitly contribute to libsql
1+
Contributing to libsql
2+
3+
Thank you for your interest in contributing to libsql! We welcome contributions from the community to make this project better.
4+
5+
Before you start, please take a moment to review the guidelines outlined below.
6+
7+
Code of Conduct
8+
9+
Please note that we have a Code of Conduct in place to ensure a positive and inclusive environment for everyone involved.
10+
11+
Getting Started
12+
13+
Fork the repository.
14+
Clone your forked repository to your local machine.
15+
Create a new branch for your feature or bug fix: git checkout -b feature-name.
16+
Make your changes and test thoroughly.
17+
Commit your changes with descriptive commit messages.
18+
Push your changes to your forked repository: git push origin feature-name.
19+
Submit a pull request to the main branch of the original repository.
20+
Contribution Guidelines
21+
22+
All contributions should be well-documented and follow the existing code style.
23+
Include tests for any new functionality or bug fixes.
24+
Update documentation as necessary, including any relevant README or usage guides.
25+
Maintain backward compatibility whenever possible.
26+
Follow the Git commit message guidelines for consistent commit messages.
27+
Review the existing issues and pull requests to avoid duplicating efforts.
28+
Pull Request Process
29+
30+
Ensure that your pull request addresses a specific issue. If there isn't an issue, consider creating one first.
31+
Clearly describe the problem or feature in your pull request and reference the relevant issue.
32+
Provide steps to reproduce and test your changes if applicable.
33+
Ensure that your branch is up-to-date with the latest changes from the main branch.
34+
All checks (tests, formatting, etc.) must pass before your pull request can be merged.
35+
After addressing review comments, your pull request will be merged by a project maintainer.
36+
Documentation
37+
38+
Help us improve the project's documentation by fixing typos, clarifying language, or adding missing information. Documentation improvements can be submitted as pull requests.
39+
40+
Reporting Issues
41+
42+
If you encounter a bug or have a suggestion for the project, please open an issue using the provided issue template. Include as much detail as possible to help us understand and address the problem.
43+
44+
Getting Help
45+
46+
If you need assistance, have questions, or want to discuss ideas, you can:
47+
48+
Join our Discord server and chat with the community.
49+
Mention @maintainer in your issue or pull request for a faster response from project maintainers.
50+
We appreciate your time and effort in contributing to libsql!
51+

0 commit comments

Comments
 (0)