👍🎉 First off, thanks for taking the time to contribute! 🎉👍
These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
Note: Please don't file an issue to ask a question. You'll get faster results by asking your question in our Discord server or by using the resources below.
The Assistant for No Man's Sky app was started by 1 person and maintained by the same person for over 2 years at the time of writing this. A lot of the code will be opinionated and a lot of the code is old and/or outdated and/or needs refactoring.
The project has gone through multiple major refactorings and still needs to go through a few more. For example, the Dart linter is throwing a lot of warnings at the moment. These will need to be solved eventually, but with nearly 2000 warnings it is a lot easier to only boyscout these issues instead of spending too long fixing these small issues.
This project was started long before Dart 2 and null safety was added. There are a lot of files that are not compliant with best practices due to this. They will slowly be fixed, over time 😅
Dart recommends snake_case for filenames: app_shell.dart
. We follow this closely so the linter is happy. We only live to make the linter feel good. Bow before the linter! Worship it, dedicate your whole life to it! It is the only true god!
First of all thank you for taking the time to check our guidelines before creating a Github issue 💪
To help keep the issues manageable, please double check that the issue you have, has not been reported already in the issues list. Secondly please ensure that you fill in as much information as possible on the issue. The issue template should help you through the process, sometimes small details help us find the bug quickly.
Please note: Just because a feature ticket exists, does not mean that we will or can build the feature.
- Ensure that there is no existing feature request on the issues page
- Research is required
- Typically when a feature is built, there is a lot of time spent gathering the data, figuring out how we are going to make use of and store the data within the apps, figuring out how to localise (translate) the data displayed.
- Some things may not be possible or will take too much time.
You can create a feature request from here