Skip to content

Commit 709a022

Browse files
committed
docs: add a 'contributing' section
1 parent 18d8f92 commit 709a022

File tree

2 files changed

+58
-0
lines changed

2 files changed

+58
-0
lines changed

docs/make.jl

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@ makedocs(;
6060
"Public" => "api/public.md",
6161
"Internal" => "api/internal.md"
6262
],
63+
"Contributing" => "contributing.md",
6364
],
6465
doctest = false,
6566
)

docs/src/contributing.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# Contributing
2+
3+
Welcome and thank you for considering contributing to TensorInference.jl.
4+
5+
By following these guidelines, you make it easier for everyone to work
6+
together. It shows you value the time of the people who create and manage this
7+
open-source project. In return, we'll show you the same respect by quickly
8+
looking at your issues, reviewing your changes, and helping you with your pull
9+
requests.
10+
11+
## Getting Started
12+
13+
Contributions are made to this repo via Issues and Pull Requests (PRs). A few
14+
general guidelines that cover both:
15+
16+
- Search for existing Issues and PRs before creating your own.
17+
- We do our best to solve problems quickly. Still, some issues take longer to
18+
understand. Posting a comment can help, especially if you need a quick fix.
19+
20+
### Issues
21+
22+
Issues should be used to report problems with the package, ask for a new
23+
feature, or discuss possible changes before creating a Pull Request (PR). When
24+
you open a new issue, please include all the details needed to look into it.
25+
26+
If you find an Issue that addresses the problem you're having, please add your
27+
own reproduction information to the existing issue rather than creating a new
28+
one.
29+
30+
### Pull Requests
31+
32+
Pull Requests (PRs) to our package are always welcome. Submitting a PR is a
33+
quick way to have your changes considered for the next software release.
34+
Generally, your Pull Request should:
35+
36+
- Either fix or add the functionality in question **OR** address widespread
37+
whitespace/style issues, not both.
38+
- Add unit or integration tests for any fixed or changed features.
39+
- Minimize the number of changed lines to address a single concern.
40+
- Include documentation in the repo, especially for implementations of new
41+
features.
42+
43+
For major changes that affect core functionality or would require a new major
44+
release, we recommend opening an Issue to discuss your ideas before creating a
45+
Pull Request. While this step is optional, it can save everyone time in both
46+
the creation and review phases.
47+
48+
In general, we follow the ["fork-and-pull" Git workflow](https://github.com/susam/gitpr)
49+
50+
1. Fork the repository to your own GitHub account.
51+
2. Clone the project to your machine.
52+
3. Create a branch locally with a succinct but descriptive name.
53+
4. Commit changes to the branch.
54+
5. Follow any formatting and testing guidelines specific to this repo.
55+
6. Push changes to your fork.
56+
7. Open a PR in our repository and complete the PR template to help us
57+
efficiently review the changes.

0 commit comments

Comments
 (0)