diff --git a/CONTRIBUTION.md b/CONTRIBUTION.md new file mode 100644 index 0000000..805167f --- /dev/null +++ b/CONTRIBUTION.md @@ -0,0 +1,19 @@ +# Contributing + +When contributing to this repository , first make sure to discuss the change you wish to make via an [issue](https://github.com/ahmadalfy/gitlab-explorer/issues) + +## Installation + +* [Follow These Steps](./README.md#getting-started) to get the project running on your machine. + +## Workflow + +* as mentioned above make sure to create an issue or grab an existing one from [here](https://github.com/ahmadalfy/gitlab-explorer/issues) + +* create a branch from `master` branch, make sure that your naming convention matches `[type]/[name]`, replace the `type` with one of `feature / fix / hotfix`. + +* make changes and use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) to format your commits messages. + +* push your changes to your fork and create a PR on the main repo, make sure you provide a good description of your changes in the PR body and attach screenshots to any UI/UX changes you make. + +* Wait for your PR to be reviewed and merged. diff --git a/README.md b/README.md index 6f9d409..e5d46d8 100644 --- a/README.md +++ b/README.md @@ -17,10 +17,11 @@ Since everything is stored in your browser, you might want to export the data so ## Getting started -1. Clone the repository. -2. Create an access token from your [gitlab settings](https://gitlab.com/profile/personal_access_tokens). You need to grant it access to `api`, `read_user`, `read_repository` and `read_registry`. -3. Copy the `env.sample.js` file to `env.js` and replace the default empty string for token option with your token (for self-hosted servers change the baseUrl option to match your domain). -4. Use an http server to run the application. There's no build steps required and you don't even need to install the required modules. +**Note: make sure to use the latest version of Chrome and enable the experamintal javascript flag from `chrome://flags`, this is important since some of the javascript used here are still not official yet** + +1. Create a `env.js` file and copy the contents of `env.sample.js` to it, replace the `token` and/or the `baseUrl` with your own gitlab instance configurations. + * you can create a personal access token from your gitlab settings and make sure to allow `api`, `read_user`, `read_repository` and `read_registry` access for that token. +2. Start a server from the project directory, the project should now be running in your browser, this project uses [snowpack](https://www.snowpack.dev/) so no building/bundling is required. ## Future plans