ALX Student's Contribution is a community of ALX students who are passionate about contributing to open source projects and doing hard things. We are willing to make contributions back to the ALX community or work on other open source projects.
We welcome contributions to fix bugs and add new features to our ALX Student's Contribution repository. If you encounter a bug or have a feature request, please create an issue on the repository so that we can track it.
If you can fix the bug or implement the feature, please follow the normal flow and submit a pull request with the changes. In the pull request description, reference the issue you're fixing by using "Fixes #1234" format, where 1234 is the issue number. This ensures that the issue is automatically closed when the pull request is merged.
If you are unable to fix the bug or implement the feature, don't worry, we will attend to it as soon as we can. Every contribution, big or small, is appreciated and we value the time and effort put into making our community better.
- Fork the repository to your GitHub account.
- Clone the forked repository to your local machine:
git clone https://github.com/<your-username>/<repository-name>.git
- Set the upstream to the original repository:
git remote add upstream https://github.com/<ALX-Student-Contribution>/<repository-name>.git
- Create a new branch for the issue you want to work on:
git checkout -b <branch-name>
-
Make changes to the codebase and test your changes locally.
-
Commit your changes with a clear commit message that references the issue you're fixing:
git commit -m "Fix issue #1234: Add new feature"
- Push your changes to your forked repository:
git push origin <branch-name>
- Create a pull request (PR) to merge your changes into the original repository.
Remember to keep your fork in sync with the original repository by doing a git fetch and git push regularly. Before submitting a pull request, make sure to test your changes locally. Provide a screen recording of the implemented changes when making the PR.
- Name your issues with a clear and descriptive title that reflects the problem or feature you're addressing.
- Name your branch with a clear and descriptive name that reflects the issue or feature you're working on. Use hyphens to separate words.
- Use a clear and descriptive commit message that references the issue you're fixing.
- When creating a PR, please provide a clear description of the changes you made and reference the issue you're fixing by writting "Fixes #1234" in the somewhere in the description.
To encourage respectful and inclusive behavior among contributors, we ask that everyone follow our Code of Conduct. Read it here: CODE_OF_CONDUCT.md.
If you discover a security vulnerability, please report it immediately by contacting us at alxstudentscontribution@gmail.com . Please do not create an issue for security vulnerabilities.
We take security vulnerabilities seriously and will work to address them as quickly as possible.
If you are interested in becoming a maintainer of the project, please reach out to us at alxstudentscontribution@gmail.com . We will consider candidates based on their contributions to the project, technical expertise, and commitment to our Code of Conduct. Maintainers are responsible for reviewing pull requests, maintaining the codebase, and helping to grow the community.
We welcome all ALX students who are interested in making contributions or working on open source projects. Join us and help us create a world where everyone has equal access to high-quality education and opportunities for personal and professional growth.