Skip to content

Commit

Permalink
Merge branch 'dev' into main
Browse files Browse the repository at this point in the history
  • Loading branch information
razwan committed Apr 15, 2022
2 parents 7a7e3b4 + 704bda9 commit c49da36
Show file tree
Hide file tree
Showing 2 changed files with 64 additions and 19 deletions.
54 changes: 54 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# Contributing to Anima theme
First of all, hats off for thinking about contributing.

The following is a set of guidelines for contributing to Anima theme. These are mostly guidelines, not rules. Use your best judgement, and feel free to propose changes to this document in a pull requet.

#### How can I contribute?
- [Reporting bugs](#reporting-bugs)
- [Contributing code](#contributing-code)
- [Feature requests and ideas](#feature-requests-and-ideas)

## Reporting bugs
Bugs are tracked as GitHub issues. Before opening a new issue bug on the project's issues page, first make sure that the issues is caused by Anima theme.

If you found a bug, the quickest way to get help would be to look through existing open and closed GitHub issues. If the issue is already being discussed and hasn't been resolved yet, you can join the discussion and provide details about your problem. If this is a new bug, please [open a new issue](https://github.com/pixelgrade/anima/issues/new?assignees=&labels=%5BType%5D+Bug&template=bug_report.md&title=).

## Contributing code
An overview of the process for contributors is:
1. Fork the Anima repository.
2. Clone the forked repository locally.
3. Create a new branch.
4. Make your changes and test thoroughly.
5. Commit your changes when you’re happy with them.
6. Push the branch to the forked repository.
7. Submit a pull request to the Anima repository.

### Prerequisites
We require certain **Node.js (v14)** and **PHP (v7.4**) versions and the easiest way to install and manage node is to use the [Node Version Manager ](https://github.com/nvm-sh/nvm) (nvm).

For the `zsh` shell you can use [oh-my-zsh](https://github.com/ohmyzsh/ohmyzsh) with the `nvm` [plugin](https://github.com/ohmyzsh/ohmyzsh/tree/master/plugins/nvm) activated.

We use the following list of `oh-my-zsh` plugins: `plugins=(composer git nvm npm)` configured in `~/.zshrc`.

For automatic node version switching, place the following line in `~/.zshrc` file, just below the plugins line: `NVM_AUTOLOAD=1`.

Now whenever you enter a directory through the shell, if it finds a `.nvmrc` file, it will switch to the specified node version.

### Getting the Anima theme code
Fork the Anima repository and then clone it to your computer using the terminal:
```
$ git clone https://github.com/your-username/anima
$ cd anima
```

### Building Anima theme
The Anima theme build system uses NodeJS. To set up it up, you first need to make sure you have NodeJS installed on your machine. Then run the following command in the project root folder to install dependencies:
```
npm install
npm run dev
```

## Feature requests and ideas
We track discussions of new features, proposed changes, and other ideas as GitHub issues. If you would like to discuss one of those, please first look through existing open and closed GitHub issues and see if there is already a discussion on this topic which you can join. If there isn't, please [open a new issue](https://github.com/pixelgrade/anima/issues/new?assignees=&labels=%5BType%5D+Feature&template=feature_request.md&title=).

When discussing new ideas or proposing changes, please take the time to be as descriptive as possible about the topic at hand. Please take the time to explain the issue you are facing, or the problem you propose to solve in as much detail as possible.
29 changes: 10 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,21 @@
# Anima – Pixelgrade Universal Theme
###

[View Demo](https://demos.pixelgrade.com/rosa2)

![rosa2_github](https://user-images.githubusercontent.com/46342490/73248468-b172c500-41bb-11ea-843e-bcc9e401e71b.jpg)
# Anima – Pixelgrade Universal Theme Name

[![](https://img.shields.io/github/issues-closed/pixelgrade/rosa2.svg?color=6cc644&label=Issues)](https://github.com/pixelgrade/rosa2/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aclosed+) [![](https://img.shields.io/github/issues/pixelgrade/rosa2.svg?color=4078c0&label=%20)](https://github.com/pixelgrade/rosa2/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen)

## Available Themes
Pixelgrade `LT` themes based on the Anima universal theme will follow the `[Theme name]` + `LT` naming convention.
- [Rosa LT](https://pixelgrade.com/themes/rosa2/) ° [View demo](https://demos.pixelgrade.com/rosa2/)

## Contributing
The essence of **open source** is that by freely sharing the code, you have the freedom to use it for any purpose, study how it works and adapt it to your needs, improve the program and **share your improvements** with the community so that we all benefit. 🙏

It's great if you're willing to use your skills, knowledge, and experience to help further refine this project with your own improvements. We really appreciate it and you're 💯 welcome to submit an issue or pull request on any topic.

### How can you help?
- 🕵️♀️ **Discovered an issue?** Please report it [here](https://github.com/pixelgrade/nova-theme/issues/new "here") and help us fix it.
- 🛠 **Fixed a bug?** That’s fantastic! Send a [pull request](https://github.com/pixelgrade/nova-theme/pulls "pull request") and we will look over it.
- 🔮 **Need a feature?** Please take a moment to find out whether your idea fit the wider scope of this theme and provide as much detail and context as possible. Then propose it [here](https://github.com/pixelgrade/nova-theme/issues/new).
- 💎 **Have you made something great?** [Share](https://github.com/pixelgrade/nova-theme/issues/new "Share") it with us.
- 🕵️♀️ **Discovered an issue?** Please report it [here](https://github.com/pixelgrade/anima/issues/new "here") and help us fix it.
- 🛠 **Fixed a bug?** That’s fantastic! Send a [pull request](https://github.com/pixelgrade/anima/pulls "pull request") and we will look over it. See [CONTRIBUTING.md](https://github.com/pixelgrade/anima/blob/main/CONTRIBUTING.md) for the contributing guidelines.
- 🔮 **Need a feature?** Please take a moment to find out whether your idea fit the wider scope of this theme and provide as much detail and context as possible. Then propose it [here](https://github.com/pixelgrade/anima/issues/new).
- 💎 **Have you made something great?** [Share](https://github.com/pixelgrade/anima/issues/new "Share") it with us.

### Contributors
A manually curated list that include all the valuable people that have contributed to this project with code, user testing, feedback, or mockups. Thank you!
Expand All @@ -31,15 +30,7 @@ For ease of development, it is best to use `nvm` (https://github.com/nvm-sh/nvm)

We use the following oh-my-zsh plugins: `plugins=(composer git nvm npm)` configured in `~/.zshrc`. For automatic node version switching, place this line in `~/.zshrc` just below the plugins line: `NVM_AUTOLOAD=1`. Now whenever you enter a directory through the shell, if it finds a `.nvmrc` file, it will switch to the specified node version.

## Local Environment Setup Pointers

You need to be careful since we **require** certain **node versions (v14) and PHP versions (v7.4).**

For ease of development, it is best to use `nvm` (https://github.com/nvm-sh/nvm) for node version management and automatic node version switching on shell navigation. For the `zsh` shell the easiest way is to use [oh-my-zsh](https://github.com/ohmyzsh/ohmyzsh) with the `nvm` [plugin](https://github.com/ohmyzsh/ohmyzsh/tree/master/plugins/nvm) activated.

We use the following oh-my-zsh plugins: `plugins=(composer git nvm npm)` configured in `~/.zshrc`. For automatic node version switching, place this line in `~/.zshrc` just below the plugins line: `NVM_AUTOLOAD=1`. Now whenever you enter a directory through the shell, if it finds a `.nvmrc` file, it will switch to the specified node version.

## License
Anima theme source code is released under the [GNU GPL v2 license or later](https://www.gnu.org/licenses/gpl-2.0.html).

2019-2021 © Pixelgrade.
2019-2022 © Pixelgrade.

0 comments on commit c49da36

Please sign in to comment.