This repository has been archived by the owner on Jan 6, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: JumperBot_ <88363421+JumperBot@users.noreply.github.com>
- Loading branch information
Showing
1 changed file
with
65 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,65 @@ | ||
# Welcome to SomeUtils contributing guide | ||
|
||
We (as one entity) salute you for actually trying to read this contributing guide. | ||
|
||
Any contribution you make will be reflected/commited to this repository, so be careful on what you're doing! | ||
|
||
Read our [Code of Conduct](./CODE_OF_CONDUCT.md) to keep our community approachable and respectable. | ||
|
||
In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR. | ||
|
||
Use the table of contents icon <img src="https://github.com/github/docs/blob/7ada1b26cf14e242d78ddf021ab743158b6a87f2/assets/images/table-of-contents.png" width="20em" height="20em" /> on the top left corner of this document to get to a specific section of this guide quickly. | ||
|
||
## New contributor guide | ||
|
||
To get an overview of the project, read the [README](README.md). | ||
|
||
Here are some resources to help you get started with open source contributions (as for GitHub Docs default): | ||
|
||
- [Finding ways to contribute to open source on GitHub](https://docs.github.com/en/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github) | ||
- [Set up Git](https://docs.github.com/en/get-started/quickstart/set-up-git) | ||
- [GitHub flow](https://docs.github.com/en/get-started/quickstart/github-flow) | ||
- [Collaborating with pull requests](https://docs.github.com/en/github/collaborating-with-pull-requests) | ||
|
||
|
||
## Navigating the repository | ||
|
||
To navigate the repository without wasting time and bandwidth. | ||
|
||
Should be automatically updated (theoretically) after every commit. | ||
|
||
<details> | ||
<summary>    └── Repository</summary> | ||
|
||
```shell | ||
└── CODE_OF_CONDUCT.md | ||
├── LICENSE | ||
├── README.md | ||
└── SomeUtils | ||
├── ProgressBar | ||
│ ├── ProgressBar.class | ||
│ └── ProgressBar.java | ||
└── Timer | ||
├── Timer.class | ||
└── Timer.java | ||
``` | ||
|
||
</details> | ||
|
||
### Issues | ||
|
||
#### Create a new issue | ||
|
||
If you spot a problem with the docs, [search if an issue already exists](https://docs.github.com/en/github/searching-for-information-on-github/searching-on-github/searching-issues-and-pull-requests#search-by-the-title-body-or-comments). | ||
|
||
If a related issue doesn't exist, you can open a new issue using a relevant [issue form](https://github.com/JumperBot/SomeUtils/issues/new/choose). | ||
|
||
#### Solve an issue | ||
|
||
Scan through our [existing issues](https://github.com/JumperBot/SomeUtils/issues) to find one that interests you. | ||
|
||
You can narrow down the search at will using filters. | ||
|
||
If you find an issue to work on, you are welcome to open a [PR](https://github.com/JumperBot/SomeUtils/compare) with a fix. | ||
|
||
Remember, fill up the form to give us as much information as possible! |