Skip to content
This repository was archived by the owner on Apr 29, 2025. It is now read-only.

Commit 9946bf9

Browse files
committed
chore: add CONTRIBUTING.md
1 parent fb2225e commit 9946bf9

File tree

1 file changed

+74
-0
lines changed

1 file changed

+74
-0
lines changed

CONTRIBUTING.md

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# Contributing to our projects
2+
3+
We welcome you to contribute to our projects, whether reporting a bug, suggesting an improvement, or submitting fixes, improvements, or new code. To ensure a smooth collaboration process please follow these guidelines.
4+
5+
## Found a bug?
6+
7+
### Search for existing issues
8+
9+
Before creating a new issue, please search existing [issues](https://github.com/overextended/ox_lib/issues) to see if it has already been reported.
10+
11+
### Add details to existing issues
12+
13+
If you have found an **active** issue which matches your own, please provide any additional details or context that might help us to resolve it.
14+
15+
### Create a new issue
16+
17+
If there is no **open** issue addresing your bug, please create a new issue - you can also reference a **closed** issue if you are certain they are related. Make sure to:
18+
19+
- Use the bug report template when creating an issue.
20+
- Include a descriptive title and a clear and detailed description of the problem.
21+
- Provide simple steps to reproduce the bug.
22+
- Include all relevant code samples.
23+
- Provide any additional information that could help diagnose the problem.
24+
25+
## Patched a bug?
26+
27+
- Submit a new pull request that includes **only the changes related to the fix**.
28+
- Clearly explain the problem being addressed and how your solution fixes it.
29+
- Reference any open issues or pull requests that your changes will resolve.
30+
31+
## Suggesting improvements or new features
32+
33+
Not all suggested improvements or features will be accepted.
34+
35+
Changes may be declined if they do not align with our design philosophy, are incomplete, not well-planned, or introduce unnecessary complexity or breaking changes to the codebase.
36+
37+
### Open an issue
38+
39+
Open a new issue to discuss your suggestion, and wait for feedback from the community and maintainers.
40+
41+
### Submit a draft
42+
43+
If you have started working on your idea, feel free to submit a **draft pull request** to gather initial feedback.
44+
45+
### Cosmetic changes
46+
47+
Pull requests that do not contribute meaningful improvements to the project's stability or functionality, such as changes to formatting or unused variables, will not be accepted.
48+
49+
## How to submit a pull request
50+
51+
- Fork the repository and, optionally, create a new branch for your changes.
52+
- If applicable, include example code to demonstrate your changes.
53+
- Ensure your code's style is consistent with the project, e.g. uses the same indentation and string quotations.
54+
- If you have modified or introduced new APIs, open a pull request to our [documentation](https://github.com/overextended/overextended.github.io). We will not accept undocumented code.
55+
56+
## Contributor License Agreement
57+
58+
This Contributor License Agreement ("Agreement") is entered into between the contributor ("Contributor") and Overextended ("Owner") for the purpose of contributing to this repository (the "Project").
59+
60+
By submitting any code, documentation, or other materials (collectively, the "Contribution") to this project, the Contributor agrees to the following terms:
61+
62+
1. **License Grant**
63+
Subject to the Contributor retaining all ownership rights in their Contribution, the Contributor hereby grants the Owner a perpetual, irrevocable, worldwide, non-exclusive license to:
64+
65+
- Use, reproduce, modify, prepare derivative works of, publicly display, publicly perform, sublicense, and distribute the Contribution,
66+
- Incorporate the Contribution into the Project or any derivative works thereof, **under the terms of the Project's License**.
67+
68+
2. **Representation and Warranties**
69+
The Contributor represents and warrants that:
70+
- The Contribution is original and is the Contributor's own work.
71+
- The Contribution does not violate any third-party rights, including copyright, patent, trademark, or trade secret rights.
72+
- The Contributor has full power and authority to enter into this Agreement and grant the rights herein.
73+
74+
By submitting a Contribution to the Project, the Contributor acknowledges that they have read, understood, and agree to be bound by the terms of this Agreement.

0 commit comments

Comments
 (0)