ninjdai/April
1
0
Fork 0
mirror of https://github.com/Art-Portal/April.git synced 2024-12-26 11:24:16 +01:00
Code Issues Packages Projects Releases Wiki Activity

Added informations

Browse Source 
Created CONTRIBUTING.md
Moved SECURITY.md to a more sensible directory: /.github/
This commit is contained in:
ninjdai1 2022-11-11 17:06:20 +01:00
parent 019235fd87
commit 5856b7a513
2 changed files with 72 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

72
.github/CONTRIBUTING.md vendored Normal file
View File

@ -0,0 +1,72 @@
# Contributing
## Request for changes/ Pull Requests
You first need to create a fork of the [April](https://github.com/Art-Portal/April/) repository to commit your changes to it. Methods to fork a repository can be found in the [GitHub Documentation](https://docs.github.com/en/get-started/quickstart/fork-a-repo).
Then add your fork as a local project:
```sh
# Using HTTPS
git clone https://github.com/Art-Portal/April.git
# Using SSH
git clone git@github.com:stevemao/github-issue-templates.git
```
> [Which remote URL should be used ?](https://docs.github.com/en/get-started/getting-started-with-git/about-remote-repositories)
Then, go to your local folder
```sh
cd github-issue-template
```
Add git remote controls :
```sh
# Using HTTPS
git remote add fork https://github.com/YOUR-USERNAME/April.git
git remote add upstream https://github.com/Art-Portal/April.git
# Using SSH
git remote add fork git@github.com:YOUR-USERNAME/April.git
git remote add upstream git@github.com/Art-Portal/April.git
```
You can now verify that you have your two git remotes:
```sh
git remote -v
```
## Receive remote updates
In view of staying up to date with the central repository :
```sh
git pull upstream beta
#Replace "beta" with the latest beta
```
## Choose a base branch
Before starting development, you need to know which branch to base your modifications/additions on. When in doubt, use the latest beta.
| Type of change | | Branches |
| :------------------ |:---------:| ---------------------:|
| Bug fixes | | `latest beta` |
| New features | | `latest beta` |
| New issues models | | `YOUR-USERNAME:patch` |
```sh
# Switch to the desired branch
git switch beta
#Replace "beta" with the latest beta
# Pull down any upstream changes
git pull
# Create a new branch to work on
git switch --create patch/1234-name-issue
```
Commit your changes, then push the branch to your fork with `git push -u fork` and open a pull request on [the April repository](https://github.com/Art-Portal/April) following the template provided.

0
SECURITY.md → .github/SECURITY.md vendored
View File