Skip to content

Commit

Permalink
Contributions: Contribution guide lines
Browse files Browse the repository at this point in the history
  • Loading branch information
forkimenjeckayang committed Jun 12, 2024
1 parent 1d42c84 commit b9b6f44
Showing 1 changed file with 72 additions and 0 deletions.
72 changes: 72 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
# Contributing to Language Translator Extension

First off, thank you for considering contributing to the Language Translator Extension! Your contributions help make this project better for everyone.

## How to Contribute

### Reporting Issues

If you find a bug or have a feature request, please create an issue in the [GitHub issue tracker](https://github.com/forkimenjeckayang/language_translator_extension/issues). Before submitting a new issue, please check if it has already been reported.

### Submitting Pull Requests

1. **Fork the Repository:**
- Navigate to the [repository on GitHub](https://github.com/forkimenjeckayang/language_translator_extension) and click the "Fork" button to create your own copy of the repository.

2. **Clone the Repository:**
- Clone your fork to your local machine(https):
```sh
git clone https://github.com/forkimenjeckayang/language_translator_extension.git
```
- Clone your fork to your local machine(ssh):
```sh
git clone [email protected]:forkimenjeckayang/language_translator_extension.git
```

3. **Create a Branch:**
- Create a new branch for your feature or bug fix:
```sh
git checkout -b my-feature-branch
```

4. **Make Changes:**
- Make your changes in the new branch. Please follow the existing code style and conventions.

5. **Commit Changes:**
- Commit your changes with a clear and descriptive commit message(Signed commits):
```sh
git commit -S -m "Add detailed description of what this commit does"
```

6. **Push Changes:**
- Push your changes to your forked repository:
```sh
git push origin my-feature-branch
```

7. **Create a Pull Request:**
- Go to the original repository on GitHub and click the "New Pull Request" button.
- Select your feature branch and submit the pull request.
- Provide a clear description of the changes you made and any additional information that might be helpful.

### Code Style

Please follow these guidelines to maintain a consistent code style:

- Use meaningful variable and function names.
- Write clear and concise comments where necessary.
- Format your code using the project's existing conventions (e.g., indentation, spacing).
### Documentation
If your changes affect the usage or functionality of the extension, please update the relevant documentation in the `README.md` file or create new documentation as necessary.
## Getting Help
If you need help with anything, feel free to open an issue or reach out by commenting on an existing issue or pull request.
---
Thank you for contributing to the Language Translator Extension! Your efforts are greatly appreciated.

0 comments on commit b9b6f44

Please sign in to comment.