Skip to content

Commit ae33968

Browse files
committed
Add nre contribution guide
1 parent 9aed61c commit ae33968

File tree

3 files changed

+84
-114
lines changed

3 files changed

+84
-114
lines changed

CONTRIBUTING.md

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
# Contributing
2+
3+
Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
4+
5+
You can contribute in many ways:
6+
7+
## Types of Contributions
8+
9+
### Report Bugs
10+
11+
Report bugs at https://github.com/jmrivas86/django-json-widget/issues.
12+
13+
If you are reporting a bug, please include:
14+
15+
* Your operating system name and version.
16+
* Any details about your local setup that might be helpful in troubleshooting.
17+
* Detailed steps to reproduce the bug.
18+
19+
### Fix Bugs
20+
21+
Look through the GitHub issues for bugs. Anything tagged with "bug" is open to whoever wants to implement it.
22+
23+
### Implement Features
24+
25+
Look through the GitHub issues for features. Anything tagged with "feature" is open to whoever wants to implement it.
26+
27+
### Write Documentation
28+
29+
django-json-widget could always use more documentation, whether as part of the official django-json-widget docs, in docstrings, or even on the web in blog posts, articles, and such.
30+
31+
### Submit Feedback
32+
33+
The best way to send feedback is to file an issue at https://github.com/jmrivas86/django-json-widget/issues.
34+
35+
If you are proposing a feature:
36+
37+
* Explain in detail how it would work.
38+
* Keep the scope as narrow as possible, to make it easier to implement.
39+
* Remember that this is a volunteer-driven project, and that contributions are welcome :)
40+
41+
## Get Started!
42+
43+
Ready to contribute? Here's how to set up `django-json-widget` for local development.
44+
45+
1. Fork the `django-json-widget` repo on GitHub.
46+
47+
2. Clone your fork locally:
48+
```bash
49+
git clone [email protected]:your_name_here/django-json-widget.git
50+
```
51+
52+
3. Install development dependencies:
53+
```bash
54+
cd django-json-widget/
55+
python -m venv .venv
56+
source .venv/bin/activate
57+
pip install -r requirements_test.txt
58+
```
59+
60+
4. Create a branch for local development from the dev branch:
61+
```bash
62+
git checkout dev
63+
git checkout -b name-of-your-branch
64+
```
65+
66+
Now you can make your changes locally.
67+
68+
5. Commit your changes and push your branch:
69+
```bash
70+
git add .
71+
git commit -m "Your detailed description of your changes."
72+
git push origin name-of-your-branch
73+
```
74+
75+
6. Submit a pull request through the GitHub website.
76+
77+
## Pull Request Guidelines
78+
79+
Before you submit a pull request, check that it meets these guidelines:
80+
81+
1. **The pull request must be submitted against the `dev` branch.**
82+
2. Please explain what you have done in the pull request.
83+
3. Make sure you have had passed pre-commit hooks.

CONTRIBUTING.rst

Lines changed: 0 additions & 113 deletions
This file was deleted.

MANIFEST.in

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
include AUTHORS.rst
22
include CONTRIBUTING.rst
3-
include CHANGELOG.rst
3+
include CHANGELOG.md
44
include LICENSE
55
include README.rst
66
recursive-include django_json_widget *.html *.png *.gif *js *.css *jpg *jpeg *svg *py

0 commit comments

Comments
 (0)