Welcome to sec-ai! Start Here for Contributing

[Elijas]

Contribution Workflow

We're excited about your interest in contributing to Alphanome AI's projects! To ensure a smooth and efficient process for all contributors, we've established this workflow. Please follow these steps to contribute effectively and avoid overlapping efforts.

Step 1: Select a Task

1. Option A: Explore Open Issues:

   • Check out our Request For Contributions board for tasks that are ready for contributions.
   • Alternatively, browse through the GitHub Issues page of a specific project, such as sec-parser Issues or sec-ai Issues.
   • Tips:
     • Look for tasks labeled contributions-welcome. These tasks align with the project goals.
     • If you're new to the project, look for tasks labeled good-first-issue.
     • Be sure to check if a task is already tagged in-progress to avoid duplicate efforts.

2. Option B: Propose a New Task:

   • Go through our Short-Term Roadmap to understand our focus areas and upcoming projects.
   • If you discover an issue or have a novel idea, feel free to propose it. Initiate a conversation either in the Discussions forum or on our Discord server.

Step 2: Prepare for Contribution

1. Read CONTRIBUTING.md:

   • Before you begin, read the CONTRIBUTING.md file of the project for guidelines on setup, coding standards, and codebase understanding.

2. Fork the Project:

   • Fork the project on GitHub to create your own workspace.

3. Communicate Your Plan:

   • We recommend commenting on the issue you're tackling to discuss your approach and seek guidance. This also allows us to tag the issue as in-progress.

4. Continuously Sync Your Fork:

   • Follow this GitHub Guide to synchronize your fork with the main repository.

Step 3: Begin Your Contribution

1. Submit a Pull Request:

   • Create a pull request with your changes, clearly explaining your contributions.

2. Check for Errors:

   • Run our automated checks and your local tests to catch and fix any issues before final submission.

We're grateful for your contributions and look forward to your valuable input in our project!

Seeking Assistance and Asking Questions

If you have any questions, or concerns, or need further clarification, feel free to reach out. Please use our Discussions page for more detailed queries and Discord for quick, conversational questions. For questions specific to a GitHub issue or pull request, kindly post them directly in the respective issue or PR thread.

---

Note
For Maintainers: Content above is taken from our Common Contributing Guide. If any updates or changes are made here, please ensure they are also reflected in the original guide for consistency.