Contributing

We welcome contributions to Asgardian! Whether you have ideas for new features, bug fixes, or documentation improvements, your help is greatly appreciated. This section provides guidelines on how to contribute effectively.

Code of Conduct

Before you start contributing, please read and adhere to our Code of Conduct.

Getting Started

Fork the Repository: Fork the Asgardian repository on GitHub.
Clone the Repository: Clone your forked repository to your local machine.
```
git clone https://github.com/nordic-ui/Asgardian.git
```
Install Dependencies: Navigate to the project directory and install the necessary dependencies.
```
cd asgardian
npm install
```
Create a Branch: Create a new branch for your changes.
```
git checkout -b feature-branch
```
Make Changes: Make your changes to the codebase.

Making Changes

Code Style

Asgardian follows a specific code style to ensure consistency. Make sure to adhere to the following guidelines:

Linting: Use ESLint to maintain consistent code style.
```
npm run lint
```
TypeScript: Write type-safe code using TypeScript.
Formatting: Use Prettier for code formatting.
```
npm run format
```

Testing

Asgardian uses Jest for testing. Ensure that your changes are covered by tests and that all existing tests pass.

Write Tests: Write tests for your changes.
Run Tests: Run the test suite to ensure everything works as expected.
```
npm test
```

Documentation

If your changes affect the public API or add new features, update the documentation accordingly.

Update MDX Files: Modify the relevant MDX files in the docs directory.
Build Documentation: Build the documentation to ensure your changes render correctly.
```
npm run docs:build
```

Submitting Changes

Commit Changes: Commit your changes with a descriptive commit message.
```
git commit -m "Add feature: [Your Feature Description]"
```
Push Changes: Push your changes to your forked repository.
```
git push origin feature-branch
```
Create a Pull Request: Open a pull request to the main repository. Provide a clear description of your changes and any related issues.

Code Reviews

Your pull request will be reviewed by the maintainers. Be open to feedback and be prepared to make necessary changes.

Community Guidelines

Be Respectful: Treat all community members with respect and kindness.
Communicate Clearly: Clearly describe your changes and the problem they solve.
Help Others: Help other contributors by reviewing their pull requests and providing constructive feedback.

Summary

Contributing to Asgardian is a great way to help improve the library and learn more about permission management. Follow the guidelines in this section to make your contributions smooth and effective.

💡

Tip

For more information, refer to the Frequently Asked Questions and Advanced Usage sections.