CONTRIBUTING.md

Contributing

We welcome contributions to this project! Before getting started, please read through this document to understand the process for submitting pull requests.

Initial discussion

Before applying code changes, it would be preferred but not required if you could create an

Setting up the development environment

1. Fork the repository
2. Clone the repository to your local machine
3. Install the dependencies by running npm install
4. Run the project locally by using the command npm start

Code of Conduct

We have a code of conduct that all contributors must adhere to. Any violations can be reported by contacting the repository maintainers.

Development Process

1. Please confirm that is no pre-existing issue for the change you wish to contribute
2. Optional: Create an issue in the repository to discuss the proposed changes
3. Create a new branch for your changes
4. Make your changes and commit them
5. Submit a pull request for review
6. The pull request will be reviewed by a maintainer and merged if approved

Issue Tracker

We use GitHub issues to track bugs and feature requests. When submitting an issue, please provide as much detail as possible and include steps to reproduce the problem.

Maintainers

• Peter Jokumsen

Scope of the Project

This project is focused on useful Angular packages to simplify processes for other developers. Contributions that align with this scope are welcome.

License

This project is licensed under the GPL-3.0 license.

Best Practices

• Comment your code
• Write test cases
• Follow the coding standards
• Use clear and descriptive commit messages using Conventional Commit Messages
• Keep the code clean and organized
• Keep code changes in a commit in a specific folder structure, i.e. changes to apps/chill-viking-ng-libs and libs/layout should be made in 2 separate commits