Skip to content

Contribution Guidelines

Thank you for considering contributing to TuxTechBlogs! We welcome your contributions and support in making this project better.

To ensure a smooth and collaborative development process, please adhere to the following guidelines:

How to Contribute

Create A Copy Of The Project In Your Account

Fork the repository to your GitHub Account.

Download the copy Of The Project

Clone your forked repository to your local machine

1
2
3
```bash
git clone https://github.com/you-accountt-name/TuxTechBlogs.git
```

Create a new branch with nomenclature

Create a new branch for your feature or bug fix

1
2
3
```bash
git checkout -b feature/your-feature-name
```

Add your Commits

Make your changes and commit them with a descriptive commit message. In order to make git commit messages easier to read and faster to reason about, we follow some guidelines on most commits to keep the format predictable. Check Conventional Commits specification for more information about our guidelines.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
### Example
```shell
// Commit Conventions
docs(changelog): update changelog to beta.5
docs: add API documentation to the bot
test(server): add cache tests to the movie resource
fix(web): add validation to phone input field
fix(web): remove avatar image from being required in form
fix(release): need to depend on latest rxjs and zone.j

// Add The Commits as mentioned convention above.
git add Contribution.md
git commit -m "docs(#issue-number): adding documentation changes and commit     guidelines."
```

Add your changes in the your forked repo repo

Push your changes to your fork on GitHub.

1
2
3
```
Make sure to replace `YourUsername`, `feature/your-feature-name`, and `[your-email@example.com]` with your actual GitHub username, branch name, and contact email. You can customize this template to match your project's specific guidelines and requirements.
```

Raise a PR from your account to main repo

Open a pull request (PR) to the main repository. Be sure to provide a clear and descriptive title and include information about the changes you've made.

Change accepted, merge done once review is successful.

Your PR will be reviewed by project maintainers. Please be open to feedback and be prepared to make additional changes if requested.

Code Style and Standards

We follow a set of coding standards and guidelines. Please ensure your code adheres to these standards.

Reporting Issues

If you encounter a bug or have a suggestion for improvement, please open an issue on the GitHub repository. Provide as much detail as possible, including the steps to reproduce the issue.

Licensing

By contributing to this project, you agree that your contributions will be licensed under the project's LICENSE.

Contact

If you have any questions or need assistance, feel free raise a blank issue for queries.

Thank you for contributing to TuxTechBlogs!

Happy coding!