Contributing¶

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

Core Team Contribution¶

All core team members should work on their feature branch. All contributions are expected to go through code review via a pull request (PR). A branch protection rule is set in the main branch (currently at least 1 reviewer is required). There shouldn’t exist commits in the main branch, except the ones created when the team merged branches.

Team members should review the changes and approve the PR within 7 days.

Team members should git pull to get the latest version of the project before making changes.

General contribution steps:

git pull to obtain the latest changes from the remote repository
git switch -c <branch_name>, where branch_name is the name of the new feature branch
Modify code & test the code
git add <related_files>, add all the modified files
git commit -m "msg", commit changes with a meaningful commit message
git push --set-upstream origin <branch_name>, pushing local changes with a new branch to the remote
Submit a PR
Other teammates should review the PR within 7 days, and approve the PR or add comments if necessary
Merge branch

Types of Contributions¶

Report Bugs¶

If you are reporting a bug, please include:

Your operating system name and version.
Any details about your local setup that might be helpful in troubleshooting.
Detailed steps to reproduce the bug.

Fix Bugs¶

Look through the GitHub issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.

Implement Features¶

Look through the GitHub issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.

Write Documentation¶

You can never have enough documentation! Please feel free to contribute to any part of the documentation, such as the official docs, docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback¶

If you are proposing a feature:

Explain in detail how it would work.
Keep the scope as narrow as possible, to make it easier to implement.
Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!¶

Ready to contribute? Here’s how to set up pysentimentanalyzer for local development.

Download a copy of pysentimentanalyzer locally.
Install pysentimentanalyzer using poetry:
```
$ poetry install
```
Use git (or similar) to create a branch for local development and make your changes:
```
$ git checkout -b name-of-your-bugfix-or-feature
```
When you’re done making changes, check that your changes conform to any code formatting requirements and pass any tests.
Commit your changes and open a pull request.

Pull Request Guidelines¶

Before you submit a pull request, check that it meets these guidelines:

The pull request should include additional tests if appropriate.
If the pull request adds functionality, the docs should be updated.
The pull request should work for all currently supported operating systems and versions of Python.

Code of Conduct¶

Please note that the pysentimentanalyzer project is released with a Code of Conduct. By contributing to this project you agree to abide by its terms.