Contributing to Angular Authentication

October 20, 2021 · View on GitHub

I would love for you to contribute to Angular Authentication! As a contributor, here are the guidelines we would like you to follow:

Bugs and Feature Requests
Submission Guidelines
Coding Rules
Commit Message Guidelines

Found a Bug or Missing a Feature?

If you find a bug in the source code or want to request a new feature, you can help by submitting an issue to this GitHub Repository. Even better, you can submit a PR with the fix or the new feature description.

Submission Guidelines

Submitting an Issue

Before you submit an issue, please search the issue tracker, maybe an issue for your problem already exists and the discussion might inform you of workarounds readily available.

You can submit a new issue here.

Submitting a Pull Request (PR)

Before you submit your Pull Request (PR) consider the following guidelines:

Search GitHub for an open or closed PR that relates to your submission. You don't want to duplicate existing efforts.
Create a new branch with a meaningful name or issue id name.
In your branch, make your changes in a new git branch:
```
git checkout -b my-fix-branch master
```
Create your patch.
Follow Coding Rules.
Commit your changes preferably using a descriptive commit message that follows commit message conventions. Adherence to these conventions is not necessary but you will save us time because release notes are automatically generated from these messages.
```
git commit --all
```
Note: the optional commit -a command line option will automatically "add" and "rm" edited files.
Push your branch to GitHub:
```
git push origin my-fix-branch
```
Make sure that you have merged any potential changes and resolve conflicts.
In GitHub, send a pull request to main.

Coding Rules

To ensure consistency throughout the source code, keep these rules in mind when you are ready to submit a PR:

Run npm run format:write for code style enforcement.
Run npm run lint for linting.
Follow SOLID & DRY principles.
Keep documentation updated.

Commit Message Format

Our commit messages follow the conventional commits specification.