Skip to content

Commit

Permalink
Create CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
seyed-dev authored Oct 28, 2023
1 parent d6bb7c4 commit 59deded
Showing 1 changed file with 47 additions and 0 deletions.
47 changes: 47 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# Contributing to Aggify
Thank you for your interest in contributing to the Aggify project! We welcome contributions from the community. By contributing, you can help make this project even better.

## How to Contribute
1 - **Fork the Repository:** Start by forking the Aggify repository to your GitHub account.

2 - **Clone the Repository:** Clone the forked repository to your local development environment:
```shell
git clone https://github.com/Aggify/aggify.git
```

3 - **Create a New Branch:** Create a new branch to work on your feature or bug fix:
```shell
git checkout -b feature-or-bugfix-name
```
4 - **Code and Test:** Make your changes, add new features, or fix bugs. Write unit tests to cover your code changes.

5 - **Documentation:** If you make any changes to the code, ensure that the code comments and documentation are updated accordingly.

6 - **Commit:** Commit your changes with a descriptive commit message. Make sure your commits follow a clear and concise format. For example:
```shell
git commit -m "Added a new feature: [Brief Description]"
```

7 - **Push:** Push your changes to your forked repository:
```shell
git push origin feature-or-bugfix-name
```
8 - **Create a Pull Request:** Open a pull request from your forked repository to the Aggify main repository on GitHub.

9 - **Code Review:** Your pull request will be reviewed by project maintainers. Be prepared to make additional changes if requested.

10 - **Merge:** Once your pull request is approved, it will be merged into the main repository.

## Guidelines
* Follow Python PEP 8 style guidelines for code formatting.
* Write clear and concise code comments and docstrings.
* Ensure all code changes are covered by unit tests.
* Test your code thoroughly before submitting a pull request.
* If you're adding a new feature, provide documentation on how to use it.
* Keep pull requests focused. If you have multiple unrelated changes, submit separate pull requests.
* Be respectful and considerate of other contributors.

## Reporting Issues
If you find a bug, have a question, or want to propose a new feature, please open an issue on the GitHub repository.

Thank you for your contributions and support. Together, we can improve Aggify for everyone.

0 comments on commit 59deded

Please sign in to comment.