Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
75 changes: 75 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
# Contribution Guide
Thank you for considering contributing to our project! We welcome contributions from the community to help make this project even better. Before you start contributing, please take a moment to read and follow this guide.

## Table of Contents
1. [Getting Started](#getting-started)
1. [How to Contribute](#how-to-contribute)
- [Fork the Repository](#fork-the-repository)
- [Clone Your Fork](#clone-your-fork)
- [Create a New Branch](#create-a-new-branch)
- [Make Changes](#make-changes)
- [Commit Your Changes](#commit-your-changes)
- [Push Your Changes](#push-your-changes)
- [Create a Pull Request](#create-a-pull-request)
1. [Reporting Bugs](#reporting-bugs)
1. [Feature Requests](#feature-requests)
1. [License](#license)

## Getting Started
Before you begin contributing, please make sure you have the following set up:

- **Git:** You should have Git installed on your local machine. You can download it from https://git-scm.com/.

- **GitHub Account:** You need a GitHub account to contribute. If you don't have one, you can sign up for free at https://github.com/.

- **Fork the Repository:** Click the "Fork" button at the top-right corner of the repository to create your copy of the project.

## How to Contribute
### Fork the Repository
Click the "Fork" button on the top-right corner of the repository's page. This will create a copy of the repository in your GitHub account.

### Clone Your Fork
Clone your fork to your local machine. Replace `<your-username>` with your GitHub username:

```bash
git clone https://github.com/<your-username>/OpenNote.git
```

### Create a New Branch
Create a new branch for your contribution. Use a descriptive branch name that reflects the purpose of your changes:

```bash
git checkout -b your-feature
```

### Make Changes
Make your desired changes to the codebase.

### Commit Your Changes
Commit your changes with a clear and concise commit message:

```bash
git add .
git commit -m "Add your commit message here"
```

### Push Your Changes
Push your changes to your GitHub fork:

```bash
git push origin feature/your-feature
```

### Create a Pull Request
Go to the original repository on GitHub. You will see a "Compare & pull request" button. Click it to open a new pull request. Provide a clear title and description for your pull request, then click "Create Pull Request."

Our team will review your contribution, and if everything looks good, your changes will be merged into the main project.

## Reporting Bugs
If you find any bugs or issues in the project, please open a GitHub issue with a detailed description of the problem, including steps to reproduce it if possible.

## Feature Requests
If you have ideas for new features or improvements, you can also open a GitHub issue to discuss your suggestions with the community.

## License
By contributing to this project, you agree that your contributions will be licensed under the [LICENSE](LICENSE) of the project.
19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,21 @@ The idea behind this project is sort of like a sleeper PC build; where the compu
![Alt text](https://raw.githubusercontent.com/nich227/OpenNote/master/screenshot.PNG)

## Technical info
Built in NetBeans 9.0 with JDK 11
Built in NetBeans 9.0 with JDK 11

## Installation
1. Clone the repository by running the following command
> git clone https://github.com/nich227/OpenNote.git
2. Change directory to the repository folder
> cd OpenNote
3. Compile the Java source code using the following command:
> javac -d build\classes src\opennote\*.java
4. Run the Java application
> java -cp build/classes opennote.OpenNote

## Installation Using NetBeans
1. Clone the repository by running the following command
> git clone https://github.com/nich227/OpenNote.git
2. Launch NetBeans
3. Click "Open Project", navigate to the project folder, click "Open Project"
4. Click "Run Project" in the top bar (green play button)