|
| 1 | +# Contributing to AboutCode |
| 2 | + |
| 3 | +Welcome! We're excited that you're interested in contributing to AboutCode. This document will help you get started with contributing to our projects. |
| 4 | + |
| 5 | +## Quick Start for New Contributors |
| 6 | + |
| 7 | +1. **Explore Our Projects**: Browse through our [project list](README.md#projects) to find something that interests you |
| 8 | +2. **Find an Issue**: Look for issues labeled `good first issue` or `help wanted` in the repository you're interested in |
| 9 | +3. **Join the Community**: Introduce yourself in our [Gitter chat](https://app.gitter.im/#/room/#aboutcode-org_discuss:gitter.im) or on [Slack](https://join.slack.com/t/aboutcode-org/shared_invite/zt-1paqwxccw-IuafuiAvYJFkTqGaZsC1og) |
| 10 | +4. **Read the Documentation**: Check out our [full documentation](https://aboutcode.readthedocs.io/en/latest/) for detailed guides |
| 11 | + |
| 12 | +## Communication Channels |
| 13 | + |
| 14 | +- **Gitter Chat**: [aboutcode-org#discuss](https://app.gitter.im/#/room/#aboutcode-org_discuss:gitter.im) |
| 15 | +- **Slack**: [Join our workspace](https://join.slack.com/t/aboutcode-org/shared_invite/zt-1paqwxccw-IuafuiAvYJFkTqGaZsC1og) |
| 16 | +- **Weekly Meetings**: We hold weekly community calls. See [meeting minutes](https://github.com/aboutcode-org/aboutcode/wiki/MeetingMinutes) for details |
| 17 | + |
| 18 | +## How to Contribute |
| 19 | + |
| 20 | +### Reporting Issues |
| 21 | + |
| 22 | +If you find a bug or have a feature request: |
| 23 | +- Check if the issue already exists |
| 24 | +- If not, create a new issue with a clear title and description |
| 25 | +- Include steps to reproduce (for bugs) or use cases (for features) |
| 26 | + |
| 27 | +### Contributing Code |
| 28 | + |
| 29 | +1. **Fork the repository** you want to contribute to |
| 30 | +2. **Create a branch** for your changes: `git checkout -b fix-issue-123` |
| 31 | +3. **Make your changes** following the project's coding standards |
| 32 | +4. **Write tests** if applicable |
| 33 | +5. **Commit your changes** with a clear commit message (see our [commit message guidelines](https://aboutcode.readthedocs.io/en/latest/contributing/writing_good_commit_messages.html)) |
| 34 | +6. **Push to your fork** and submit a pull request |
| 35 | + |
| 36 | +### Contributing Documentation |
| 37 | + |
| 38 | +Documentation improvements are always welcome! You can: |
| 39 | +- Fix typos or clarify existing documentation |
| 40 | +- Add examples or tutorials |
| 41 | +- Improve the structure and organization |
| 42 | + |
| 43 | +Documentation is built using Sphinx. To build locally: |
| 44 | +```bash |
| 45 | +make docs |
| 46 | +``` |
| 47 | + |
| 48 | +## Development Guidelines |
| 49 | + |
| 50 | +### Commit Messages |
| 51 | + |
| 52 | +We follow specific commit message conventions: |
| 53 | +- Use imperative mood ("Add feature" not "Added feature") |
| 54 | +- Keep the subject line under 50 characters |
| 55 | +- Reference issue numbers when applicable (#123) |
| 56 | +- Sign off your commits with `Signed-off-by: Your Name <your.email@example.com>` |
| 57 | + |
| 58 | +For detailed guidelines, see our [commit message documentation](https://aboutcode.readthedocs.io/en/latest/contributing/writing_good_commit_messages.html). |
| 59 | + |
| 60 | +### Testing |
| 61 | + |
| 62 | +Before submitting a pull request: |
| 63 | +- Run existing tests to ensure nothing breaks |
| 64 | +- Add new tests for new functionality |
| 65 | +- Ensure all tests pass |
| 66 | + |
| 67 | +See the [testing documentation](https://aboutcode.readthedocs.io/en/latest/contributing/testing.html) for more details. |
| 68 | + |
| 69 | +## Code of Conduct |
| 70 | + |
| 71 | +We are committed to providing a welcoming and inclusive environment. Please read our [Code of Conduct](CODE_OF_CONDUCT.rst) before participating. |
| 72 | + |
| 73 | +## Getting Help |
| 74 | + |
| 75 | +- **Documentation**: Start with our [ReadTheDocs](https://aboutcode.readthedocs.io/en/latest/) |
| 76 | +- **Chat**: Ask questions on [Gitter](https://app.gitter.im/#/room/#aboutcode-org_discuss:gitter.im) or [Slack](https://join.slack.com/t/aboutcode-org/shared_invite/zt-1paqwxccw-IuafuiAvYJFkTqGaZsC1og) |
| 77 | +- **Issues**: Open an issue in the relevant repository if you need help with something specific |
| 78 | + |
| 79 | +## Additional Resources |
| 80 | + |
| 81 | +- [Full Contributing Guide](https://aboutcode.readthedocs.io/en/latest/contributing.html) |
| 82 | +- [Documentation Contribution Guide](https://aboutcode.readthedocs.io/en/latest/contributing/contrib_doc.html) |
| 83 | +- [GSoC Information](https://github.com/aboutcode-org/aboutcode/wiki) |
| 84 | + |
| 85 | +## License |
| 86 | + |
| 87 | +By contributing to AboutCode, you agree that your contributions will be licensed under the Apache License 2.0. |
| 88 | + |
| 89 | +--- |
| 90 | + |
| 91 | +Thank you for contributing to AboutCode! Your efforts help make open source software safer and more transparent for everyone. |
0 commit comments