e42819ef64
- Updated .env.example and .env files for backend and frontend with placeholder values. - Enhanced .gitignore to include additional files and directories. - Modified docker-compose.yml to change image names and improve service health checks. - Updated README.md and SETUP_THE_PROJECT.md for clearer setup instructions. - Added database initialization scripts and SQL files for structured database setup. - Updated frontend Dockerfile to use Node.js 22 and adjusted package.json scripts. - Improved error handling and logging in start scripts for better debugging. - Added reCAPTCHA support in the signup page with conditional loading based on environment variables.
43 lines
2.1 KiB
Markdown
43 lines
2.1 KiB
Markdown
# Contributing to Worklenz
|
|
|
|
Thanks for your interest in contributing to Worklenz!
|
|
|
|
We truly appreciate your willingness to invest your time and effort in helping us improve Worklenz.
|
|
## Code of Conduct
|
|
|
|
We have adopted a Code of Conduct to ensure a welcoming and inclusive environment for everyone. Please read and follow our [Code of Conduct](CODE_OF_CONDUCT.md) when participating in this project.
|
|
|
|
## How to Contribute
|
|
|
|
1. Fork the repository and create a new branch for your feature or bug fix.
|
|
2. Make your changes and ensure that the code follows our coding standards.
|
|
3. Write tests for your changes, if applicable.
|
|
4. Update the documentation if necessary.
|
|
5. Commit your changes with descriptive commit messages.
|
|
6. Push your changes to your forked repository.
|
|
7. Create a pull request against the main repository's `main` branch.
|
|
|
|
## Coding Standards
|
|
|
|
- Follow the [React Documentation](https://react.dev/learn) for best practices in React development.
|
|
- Use [TypeScript](https://www.typescriptlang.org/) for both frontend and backend code.
|
|
- Follow the [Conventional Commits](https://www.conventionalcommits.org/) specification for commit messages.
|
|
|
|
## Issues
|
|
|
|
If you encounter any issues or have suggestions for improvements, please open an issue on our [issue tracker](https://github.com/worklenz/worklenz/issues). Be sure to provide as much information as possible, including steps to reproduce the issue, expected behavior, and actual behavior.
|
|
|
|
## Pull Requests
|
|
|
|
All contributions should be submitted as pull requests against the `development` branch of the main repository. We will review and provide feedback on your pull request as soon as possible. Please ensure that your pull request meets the following criteria:
|
|
|
|
- Follows our coding standards
|
|
- Updates documentation, if necessary
|
|
- Has descriptive commit messages
|
|
|
|
## License
|
|
|
|
By contributing to Worklenz, you agree that your contributions will be licensed under the [GNU Affero General Public License Version 3 (AGPLv3)](LICENSE).
|
|
|
|
Thank you again for your interest in contributing to Worklenz! We look forward to your contributions.
|