How to Contribute
To contribute to Decentra projects, follow these steps:
Fork the Repository:
Go to the projectβs GitHub repository and fork it to your personal GitHub account.
Make the Fork Private:
Ensure your forked repository is set to private.
On GitHub, navigate to your forked repository's settings.
Under the "General" tab, check the "Private" option.
Clone the Fork:
Clone your private forked repository to your local machine using the command
git clone https://github.com/yourusername/project-repo.git
.
Create a Branch:
Create a new branch for your work using the command
git checkout -b feature-branch
.
Make Changes:
Implement your changes following the Style Guide and Testing Guidelines.
Add Tests:
Ensure your changes include tests with 100% coverage. Refer to Addressing attack vectors for security-related tests.
Commit Changes:
Commit your changes with a meaningful commit message using the commands
git add .
andgit commit -m "Description of your changes"
.
Push to GitHub:
Push your changes to your private fork on GitHub using the command
git push origin feature-branch
.
Invite Reviewers:
Invite the Decentra team and judges to view your private fork. Their GitHub usernames are listed at the end of every project's sprint documentation.
On GitHub, navigate to the "Settings" of your private fork.
Under "Manage Access," invite the team members and judges.
Create a Pull Request:
Once your changes are ready and reviewed, navigate to the original repository and create a pull request from your private fork. Use the PR template provided.
By following these steps, you ensure that your contributions are private, secure, and align with the standards of the Decentra platform.