bo/worklenz
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

initial commit

Browse Source
This commit is contained in:
chamikaJ
2024-05-16 11:28:26 +05:30
commit 67696d6f98
6 changed files with 1066 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
CONTRIBUTING.md Normal file
View File

@@ -0,0 +1,42 @@
# 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 [Angular Style Guide](https://angular.io/guide/styleguide) for the frontend code.
- 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.