Skip to content

Commit 151ee36

Browse files
authored
Create CONTRIBUTING.md
1 parent bfae6a4 commit 151ee36

1 file changed

Lines changed: 47 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Contributing to Java Algorithms and Data Structures
2+
3+
Thank you for taking the time to contribute to this project! Here are a few guidelines to help you get started.
4+
5+
## How to Contribute
6+
7+
1. **Fork the repository**: Click the 'Fork' button at the top right of the repository page to create a copy of the repository in your GitHub account.
8+
9+
2. **Clone the repository**: Clone your forked repository to your local machine using the following command:
10+
```sh
11+
git clone https://github.com/your-username/java-alda.git
12+
```
13+
14+
3. **Create a branch**: Create a new branch for your work using the following command:
15+
```sh
16+
git checkout -b your-branch-name
17+
```
18+
19+
4. **Make your changes**: Implement your changes in the new branch. Ensure your code follows the project's coding standards and passes all tests.
20+
21+
5. **Commit your changes**: Commit your changes with a meaningful commit message using the following commands:
22+
```sh
23+
git add .
24+
git commit -m "Description of your changes"
25+
```
26+
27+
6. **Push your changes**: Push your changes to your forked repository using the following command:
28+
```sh
29+
git push origin your-branch-name
30+
```
31+
32+
7. **Create a pull request**: Navigate to the original repository on GitHub and create a pull request from your forked repository. Provide a clear description of your changes and any related issue numbers.
33+
34+
## Code of Conduct
35+
36+
This project follows the [Contributor Covenant Code of Conduct](https://www.contributor-covenant.org/version/2/0/code_of_conduct/). By participating, you are expected to uphold this code. Please report unacceptable behavior to bcexpt1123@gmail.com.
37+
38+
## Reporting Issues
39+
40+
If you encounter any issues while using the project, please check if the issue has already been reported. If not, create a new issue with a clear description of the problem, steps to reproduce it, and any relevant information.
41+
42+
## Coding Standards
43+
44+
- Ensure your code is well-documented and follows the project's coding style.
45+
- Write tests for your code and ensure all tests pass before submitting a pull request.
46+
47+
Thank you for contributing!

0 commit comments

Comments
 (0)