|
| 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 | +- [What to work on](#what-to-work-on) |
| 12 | +- [Reporting bugs and requesting features](#reporting-bugs-and-requesting-features) |
| 13 | +- [Contributing pull requests](#contributing-pull-requests) |
| 14 | + |
| 15 | +## Communication |
| 16 | + |
| 17 | +Second Life has multiple channels for communication. Some of these channels are |
| 18 | +more end-user focused, while others are more tailored for |
| 19 | +developer-to-developer or support. |
| 20 | + |
| 21 | +- [feedback.secondlife.com][] is Second Life's primary community engagement |
| 22 | + forum. Ideas and bug reports should be placed here unless they relate to |
| 23 | + ongoing development issues and developer-to-developer communication. |
| 24 | +- [Public user groups][slug] are held on a regular basis, including those for |
| 25 | + discussing open source development, content creation, server topics and more. |
| 26 | +- [Github issues][] provide a means for staff to organize their |
| 27 | + work and collaborate with other developers. By default most user-facing |
| 28 | + discussions should happen on [feedback.secondlife.com][] so that they are |
| 29 | + visible to more people, can build consensus, and be placed onto our public |
| 30 | + roadmap. Github issues are useful for collaboration between viewer forks |
| 31 | + and the official upstream and when engineering-specific and technical |
| 32 | + collaboration is beneficial. |
| 33 | +- [Official forums][] exist for many topics including content creation, |
| 34 | + scripting, social topics and more. |
| 35 | +- The [opensource-dev mailing list][] is useful for announcements and |
| 36 | + discussion between viewer maintainers. |
| 37 | +- Our [discord channel](https://discord.com/channels/677442248157167619/1357059883400167585) is available for real-time discussion. |
| 38 | + |
| 39 | +## What to work on |
| 40 | + |
| 41 | +If you're looking for ways to contribute code, here are some ways to get involved: |
| 42 | + |
| 43 | +- Explore existing issues on the [GitHub issue tracker](https://github.com/secondlife/viewer/issues) to find known problems, bugs, or enhancement discussions. |
| 44 | +- File new issues if you’ve discovered a bug or have a specific idea to propose. If your idea is user-facing, consider submitting it through feedback.secondlife.com so it can reach a broader audience and be prioritized by Linden Lab staff. |
| 45 | +- Look for the [help wanted](https://github.com/secondlife/viewer/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22help%20wanted%22) label. These are tasks the core maintainers have specifically identified as good candidates for community help. |
| 46 | +- Talk to maintainers before starting significant work. Even if an issue exists, discussing your approach first ensures alignment with ongoing efforts and increases the likelihood your pull request will be accepted. |
| 47 | + |
| 48 | +Collaboration is essential. We encourage contributors to work closely with the Second Life engineering team and other developers to keep work consistent and maintainable. |
| 49 | + |
| 50 | +## Reporting bugs and requesting features |
| 51 | + |
| 52 | +Report bugs and provide ideas for features using the respective board on Second |
| 53 | +Life's feedback portal: |
| 54 | + |
| 55 | +- [Features](https://feedback.secondlife.com/feature-requests) |
| 56 | +- [Scripting bugs](https://feedback.secondlife.com/scripting-bugs) |
| 57 | +- [Scripting features](https://feedback.secondlife.com/scripting-features) |
| 58 | +- [Server bugs](https://feedback.secondlife.com/scripting-bugs) |
| 59 | +- [Viewer bugs](https://feedback.secondlife.com/bug-reports) |
| 60 | +- [Web/Marketplace bugs](https://feedback.secondlife.com/web-bugs) |
| 61 | +- [Web/Marketplace features](https://feedback.secondlife.com/web-features) |
| 62 | + |
| 63 | +Creating posts on feedback.secondlife.com is important as it allows the greatest |
| 64 | +exposure and input from Second Life users. It also allows Linden Lab staff to |
| 65 | +place work on a single public roadmap. |
| 66 | + |
| 67 | +Issues created on feedback.secondlife.com are imported onto Github after they |
| 68 | +have been reviewed by staff and accepted. |
| 69 | + |
| 70 | +## Contributing pull requests |
| 71 | + |
| 72 | +If you wish to contribute a new pull request, please ensure that: |
| 73 | + |
| 74 | +- You talk to other developers about how best to implement the work. |
| 75 | +- The functionality is desired. Be sure to talk to users and Second Life staff to ensure |
| 76 | + the work is a good idea and will be accepted. |
| 77 | +- The work is high quality and the PR follows [PR etiquette][] |
| 78 | +- You have tested the work locally |
| 79 | + |
| 80 | +The [Git Style Guide](https://github.com/agis/git-style-guide) is also a good |
| 81 | +reference for best git practices. |
| 82 | + |
| 83 | +[feedback.secondlife.com]: https://feedback.secondlife.com |
| 84 | +[slug]: https://community.secondlife.com/blogs/entry/6509-introducing-the-second-life-public-calendar/ |
| 85 | +[PR etiquette]: https://gist.github.com/mikepea/863f63d6e37281e329f8 |
| 86 | +[Github issues]: https://github.com/secondlife/viewer/issues |
| 87 | +[Official forums]: https://community.secondlife.com/forums/ |
| 88 | +[opensource-dev mailing list]: https://wiki.secondlife.com/wiki/OpenSource-Dev |
0 commit comments