wekan/CONTRIBUTING.md

74 lines
2.1 KiB
Markdown
Raw Normal View History

2023-02-16 00:16:00 +02:00
## Contributing Security related
For responsible security disclosure, please follow this process:
https://github.com/wekan/wekan/blob/master/SECURITY.md
CVE Hall of Fame is at https://wekan.github.io/hall-of-fame/
## Contributing to Documentation Wiki
2018-05-22 09:29:00 +03:00
2022-09-19 11:50:10 +03:00
Please clone wiki:
```
git clone https://github.com/wekan/wekan.wiki
```
Edit .md files, and add changed files in .zip attachment
directly to comment of new issue at
https://github.com/wekan/wekan/issues
2018-05-22 09:29:00 +03:00
2022-09-19 11:50:10 +03:00
## Contributing code
[Building WeKan and sending PR](https://github.com/wekan/wekan/wiki/Emoji).
2023-02-16 00:16:00 +02:00
WeKan code contributors Hall of Fame is at ChangeLog, where
GitHub usernames are mentioned with changes added:
https://github.com/wekan/wekan/blob/master/CHANGELOG.md
Changes can be like typo fixes, bugfixes, features, or anything else
like for example at open GitHub issues https://github.com/wekan/wekan/issues .
Closed issues are already fixed or implemented.
Also see other docs at wiki, for example:
2022-09-19 11:50:10 +03:00
2023-02-16 00:16:00 +02:00
https://github.com/wekan/wekan/wiki/Developer-Documentation
Do not use code formatting or linting like eslist or prettier.
Only send minimal changed code lines, that are related to feature or fix.
2022-09-19 11:50:10 +03:00
WeKan code has MIT license.
2023-02-16 00:22:52 +02:00
About 300 persons have contributed to WeKan, stats at:
https://www.openhub.net/p/wekan
2023-02-16 00:16:00 +02:00
WeKan maintainer xet7 checks PR for typos etc before accepting to WeKan,
so that WeKan code will still work OK.
2022-09-19 11:50:10 +03:00
## Contributing translations
Non-English translations are contributed only at
https://transifex.com/wekan/wekan
When adding new features, in your PR to
https://github.com/wekan/wekan/pulls
only add new English source language strings
to https://github.com/wekan/wekan/blob/master/imports/i18n/data/en.i18n.json
Maintainer of WeKan xet7 downloads all newest
translations from Transifex and adds
them to WeKan repo before making
new release.
2023-02-16 00:16:00 +02:00
## About WeKan Organization https://github.com/wekan
xet7 rarely adds any new members to GitHub Organization,
because xet7 prefers to check PRs.
For some repos (other than https://github.com/wekan/wekan ),
some contributors have direct commit access.
2023-02-16 00:19:39 +02:00
Some contributors are mentioned at this outdated page:
https://github.com/wekan/wekan/wiki/Team