Skip to content

Commit 1094710

Browse files
committed
Add a basic CONTRIBUTING.md
Provide basic instructions in-repository for contributing to Second Life.
1 parent 77395ed commit 1094710

File tree

2 files changed

+78
-1
lines changed

2 files changed

+78
-1
lines changed

CONTRIBUTING.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Contributor guidelines
2+
3+
Thanks for your interest in contributing to Second Life! This document
4+
summarizes some of the most important points for people looking to contribute
5+
to the platform especially those looking to provide bug reports and code
6+
changes.
7+
8+
## Table of contents
9+
10+
- [Communication](#communication)
11+
- [Reporting bugs and requesting features](#reporting-bugs-and-requesting-features)
12+
- [Contributing pull requests](#contributing-pull-requests)
13+
14+
## Communication
15+
16+
Second Life has multiple channels for communication. Some of these channels are
17+
more end-user focused, while others are more tailored for
18+
developer-to-developer or support.
19+
20+
- [feedback.secondlife.com][] is Second Life's primary community engagement
21+
forum. Ideas and bug reports should be placed here unless they relate to
22+
ongoing development issues and developer-to-developer communication.
23+
- [Public user groups][slug] are held on a regular basis, including those for
24+
discussing open source development, content creation, server topics and more.
25+
- [Github issues][] provide a means for staff to organize their
26+
work and collaborate with other developers. By default most user-facing
27+
discussions should happen on [feedback.secondlife.com][] so that they are
28+
visible to more people, can build consensus, and be placed onto our public
29+
roadmap. Github issues are useful for collaboration between viewer forks
30+
and the official upstream and when engineering-specific and technical
31+
collaboration is beneficial.
32+
- [Official forums][] exist for many topics including content creation,
33+
scripting, social topics and more.
34+
- The [opensource-dev mailing list][] is useful for announcements and
35+
discussion between viewer maintainers.
36+
37+
38+
## Reporting bugs and requesting features
39+
40+
Report bugs and provide ideas for features using the respective board on Second
41+
Life's feedback portal:
42+
43+
- [Features](https://feedback.secondlife.com/feature-requests)
44+
- [Scripting bugs](https://feedback.secondlife.com/scripting-bugs)
45+
- [Scripting features](https://feedback.secondlife.com/scripting-features)
46+
- [Server bugs](https://feedback.secondlife.com/scripting-bugs)
47+
- [Viewer bugs](https://feedback.secondlife.com/bug-reports)
48+
- [Web/Marketplace bugs](https://feedback.secondlife.com/web-bugs)
49+
- [Web/Marketplace features](https://feedback.secondlife.com/web-features)
50+
51+
Creating posts on feedback.secondlife.com is important as it allows the greatest
52+
exposure and input from Second Life users. It also allows Linden Lab staff to
53+
place work on a single public roadmap.
54+
55+
Issues created on feedback.secondlife.com are imported onto Github after they
56+
have been reviewed by staff and accepted.
57+
58+
## Contributing pull requests
59+
60+
If you wish to contribute a new pull request, please ensure that:
61+
62+
- You talk to other developers about how best to implement the work.
63+
- The functionality is desired. Be sure to talk to users and Second Life staff to ensure
64+
the work is a good idea and will be accepted.
65+
- The work is high quality and the PR follows [PR etiquette][]
66+
- You have tested the work locally
67+
68+
The [Git Style Guide](https://github.com/agis/git-style-guide) is also a good
69+
reference for best git practices.
70+
71+
[feedback.secondlife.com]: https://feedback.secondlife.com
72+
[slug]: https://community.secondlife.com/blogs/entry/6509-introducing-the-second-life-public-calendar/
73+
[PR etiquette]: https://gist.github.com/mikepea/863f63d6e37281e329f8
74+
[Github issues]: https://github.com/secondlife/viewer/issues
75+
[Official forums]: https://community.secondlife.com/forums/
76+
[opensource-dev mailing list]: https://wiki.secondlife.com/wiki/OpenSource-Dev

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,10 @@ Third party maintained forks, which include Linux compatible builds, are indexed
3535
## Contribute
3636

3737
Help make Second Life better! You can get involved with improvements by filing bugs, suggesting enhancements, submitting
38-
pull requests and more. See the [open source portal][] for details.
38+
pull requests and more. See the [CONTRIBUTING][] and the [open source portal][] for details.
3939

4040
[Second Life]: https://secondlife.com/
4141
[download]: https://secondlife.com/support/downloads/
4242
[tpv]: http://wiki.secondlife.com/wiki/Third_Party_Viewer_Directory
4343
[open source portal]: http://wiki.secondlife.com/wiki/Open_Source_Portal
44+
[contributing]: https://github.com/secondlife/viewer/blob/main/CONTRIBUTING.md

0 commit comments

Comments
 (0)