Skip to content

docs: update readme and add setup instructions to contirbutors.md #512

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Jefiozie merged 2 commits into from
May 19, 2025
Merged

docs: update readme and add setup instructions to contirbutors.md #512

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f05666e
docs: update readme and add setup instructions to contirbutors.md
SanderElias May 19, 2025
dda856f
docs: small fix in readme
SanderElias May 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 36 additions & 7 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,41 @@ We would love for you to contribute to angular-split and help make it even bette
than it is today! As a contributor, here are the guidelines we would like you
to follow:

- [Code of Conduct](#coc)
- [Issues and Bugs](#issue)
- [Feature Requests](#feature)
- [Submission Guidelines](#submit)
- [Coding Rules](#rules)
- [Commit Message Guidelines](#commit)
- [Contributing to angular-split](#contributing-to-angular-split)
- [ Setting up your Environment](#-setting-up-your-environment)
- [ Code of Conduct](#-code-of-conduct)
- [ Got a Question or Problem?](#-got-a-question-or-problem)
- [ Found an Issue?](#-found-an-issue)
- [ Want a Feature?](#-want-a-feature)
- [ Submission Guidelines](#-submission-guidelines)
- [ Submitting an Issue](#-submitting-an-issue)
- [ Submitting a Pull Request (PR)](#-submitting-a-pull-request-pr)
- [After your pull request is merged](#after-your-pull-request-is-merged)
- [ Coding Rules](#-coding-rules)
- [ Commit Message Guidelines](#-commit-message-guidelines)
- [Commit Message Format](#commit-message-format)
- [Revert](#revert)
- [Type](#type)
- [Scope](#scope)
- [TODO](#todo)
- [Subject](#subject)
- [Body](#body)
- [Footer](#footer)

## <a name="setup"></a> Setting up your Environment

To set up your environment to work on angular-split, follow these steps:

1. **Fork the repository** on GitHub to your own account.
2. **Clone the repository** to your local machine
3. **Install the dependencies**: `npm install`

> Note: If you are using a version of Node.js that is not supported by angular-split, you might need to use `nvm` (Node Version Manager) to switch to a compatible version. The recommended version is Node.js 22.x LTS or later.

4. **build and run the project by**: `npm run start --watch`

For windows users, we expect you to use the WSL, as we set up the project to work with github actions. Make sure to check out the project and run the commands in the WSL terminal.
It might work outside the WSL when you delete the `package-lock.json` file, but we cannot guarantee that it will work. (also, make sure you don't commit that `package-lock.json`, as it will break the build for other users).

## <a name="coc"></a> Code of Conduct

Expand Down Expand Up @@ -190,7 +219,7 @@ Must be one of the following:
The scope should be the name of the module affected as perceived by the person reading changelog generated from the commit messages.

The following is the list of supported scopes (there might be more added in the fututre):

## TODO

There are currently a few exceptions to the "use package name" rule:
Expand Down
15 changes: 11 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,20 @@ Angular UI library to split views and allow dragging to resize areas using CSS g
Documentation and examples:
[https://angular-split.github.io](https://angular-split.github.io)

### Credits
## Credits

#### Built by [Bertrand Gaillard](https://github.com/bertrandg)
### Built by [Bertrand Gaillard](https://github.com/bertrandg)

#### Maintained by: [Bram Borggreve](https://github.com/beeman) (As of 2020)
### Maintained by: (As of 2024)

#### Previously: [Bertrand Gaillard](https://github.com/bertrandg) (2016 to 2019)
- [Jeffrey Bosch](https://jefiozie.github.io)
- [Sander Elias](https://github.com/SanderElias)
- [harpush](https://github.com/Harpush)

#### Previously

- Maintained by: [Bram Borggreve](https://github.com/beeman) (2020 to 2024)
- Build and maintained [Bertrand Gaillard](https://github.com/bertrandg) (2016 to 2019)

## Contributors

Expand Down