Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
nheko
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Iterations
Wiki
Requirements
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Locked files
Build
Pipelines
Jobs
Pipeline schedules
Test cases
Artifacts
Deploy
Releases
Package Registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Code review analytics
Issue analytics
Insights
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Nheko Reborn
nheko
Commits
592640ad
Commit
592640ad
authored
6 years ago
by
Konstantinos Sideris
Browse files
Options
Downloads
Patches
Plain Diff
Add contributing document
parent
ccf089dd
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
.github/CONTRIBUTING
+39
-0
39 additions, 0 deletions
.github/CONTRIBUTING
README.md
+1
-2
1 addition, 2 deletions
README.md
with
40 additions
and
2 deletions
.github/CONTRIBUTING
0 → 100644
+
39
−
0
View file @
592640ad
## Contributing to nheko
Any kind of contribution to the project is greatly appreciated.
- Bug fixes
- Implementing new features
- UI/UX improvements/suggestions
- Code refactoring
- Translations
### Working on new features
Everything on the issue tracker is up for grabs unless someone else is
currently working on it.
If you're planning to work on a new feature leave a message on the Matrix room
(or in the corresponding issue), so we won't end up having duplicate work.
### Submitting a translation
Example for a Japanese translation.
- Create a new translation file using the prototype in English
- e.g `cp resources/langs/nheko_en.ts resources/langs/nheko_jp.ts`
- Open the new translation file and change the line regarding the locale to reflect the current language.
- e.g `<TS version="2.1" language="en">` => `<TS version="2.1" language="jp">`
- Run `make update-translations` to update the translation files with any missing text.
- Fill out the translation file (Qt Linguist can make things easier).
- Submit a PR!
### Code style
We use clang-format to enforce a certain style as defined by the `.clang-format`
file in the root of the repo. Travis-CI will run the linter (macOS job) on each
commit and the build will fail if the style guide isn't followed. You can run the
linter locally with `make lint`.
If you have any questions don't hesitate to reach out to us on #nheko:matrix.org.
This diff is collapsed.
Click to expand it.
README.md
+
1
−
2
View file @
592640ad
...
...
@@ -163,8 +163,7 @@ You can also install nheko by running `nix-env -f . -i`
### Contributing
Any kind of contribution to the project is greatly appreciated. You are also
encouraged to open feature request issues.
See
[
CONTRIBUTING
](
.github/CONTRIBUTING
)
### Screens
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment