All work on Friendly Web happens directly on GitHub. Both core team members and external contributors submit pull requests which go through the same review process.
P.S. If you're on Windows - don't forget to force EOL replacing for git: git config --global core.autocrlf true
https://github.com/friendly-social/knowledge/blob/dev/PROCESS.md#releases
Submit all changes only to the dev branch. Code that lands in the dev branch can contain any kind of changes related to project and its goals. Core team can create alternative branches based on the dev branch instead of working in forks.
For any Web client related bugs and problems we use GitHub Issues. We keep a close eye on this and try to make it clear when we have an internal fix in progress. Before filing a new commit, try to make sure your problem doesn’t already exist.
If you intend to implement a new feature, enhance existing implementation, fix a bug or something else - we recomment filing an issue first. This lets us reach an agreement on your changes before you put significant effort into it.
If you decide to fix an issue, please be sure to check the comment thread and existing pull requests in case if somebody is already working on it. If nobody is working on it at the moment, please leave a comment stating that you intend to work on it. If somebody claims an issue but doesn't follow up for some time - it is fine to take it over.
After cloning repo, run bun install to fetch its dependencies. Then, you can run several commands:
bun lintchecks the code style.bun formatwill reformat code where it's possible.bun buildto build production-ready app.bun devto start dev server.
We use an automatic code formatter called Prettier. However, there are still some style rules that the linter cannot pick up. Right now we don't have code style document, so feel free to ask us.
- Discussions
- Issues (as mentioned in previews paragraph)
By contributing to this repo, you agree that your contributions will be licensed under its GPL-2.0 license.